phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Example
Exception
Filter
Interfaces
ProjectDescriptor
Query
TableOfContents
Tag
BaseTypes
Traits
Validation
ValueObjects
Event
Guides
DependencyInjection
Handlers
References
Resolver
Php
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig
LinkRenderer

\phpDocumentor\Transformer\Writer\Twig\LinkRendererUrlGenerator

Url generator for rendering links in the twig templates.

Summary

Methods
Properties
Constants
__construct()
generate()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
generateGuideUrl()
isGuideUrl()
withoutLeadingSlash()
$rendererChain
$router
N/A

Properties

$rendererChain

$rendererChain : \phpDocumentor\Transformer\Writer\Twig\LinkRenderer

Type

\phpDocumentor\Transformer\Writer\Twig\LinkRenderer

$router

$router : \phpDocumentor\Transformer\Router\Router

Type

\phpDocumentor\Transformer\Router\Router

Methods

__construct()

__construct(\phpDocumentor\Transformer\Writer\Twig\LinkRenderer  $rendererChain, \phpDocumentor\Transformer\Router\Router  $router) : mixed

Parameters

\phpDocumentor\Transformer\Writer\Twig\LinkRenderer $rendererChain
\phpDocumentor\Transformer\Router\Router $router

Returns

mixed —

generate()

generate(string|\phpDocumentor\Path|\phpDocumentor\Reflection\Type|\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Fqsen  $target, string  $fallback) : ?string

Parameters

string|\phpDocumentor\Path|\phpDocumentor\Reflection\Type|\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Fqsen $target
string $fallback

Returns

?string —

generateGuideUrl()

generateGuideUrl(string|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Url  $target) : ?string

Parameters

string|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Url $target

Returns

?string —

isGuideUrl()

isGuideUrl(string|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Url  $target) : bool

Parameters

string|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Url $target

Returns

bool —

withoutLeadingSlash()

withoutLeadingSlash(string  $path) : string

Parameters

string $path

Returns

string —