$routeRenderer
$routeRenderer : \phpDocumentor\Transformer\Writer\Twig\LinkRenderer
Basic extension adding phpDocumentor specific functionality for Twig templates.
Global variables:
Functions:
Filters:
__construct(\phpDocumentor\Descriptor\ProjectDescriptor $project, \phpDocumentor\Descriptor\DocumentationSetDescriptor $documentationSet, \League\CommonMark\ConverterInterface $markdownConverter, \phpDocumentor\Transformer\Writer\Twig\LinkRenderer $routeRenderer, \phpDocumentor\Transformer\Writer\Twig\RelativePathToRootConverter $relativePathToRootConverter, \phpDocumentor\Transformer\Writer\Twig\PathBuilder $pathBuilder) : mixed
Registers the structure and transformation with this extension.
\phpDocumentor\Descriptor\ProjectDescriptor | $project | Represents the complete Abstract Syntax Tree. |
\phpDocumentor\Descriptor\DocumentationSetDescriptor | $documentationSet | |
\League\CommonMark\ConverterInterface | $markdownConverter | |
\phpDocumentor\Transformer\Writer\Twig\LinkRenderer | $routeRenderer | |
\phpDocumentor\Transformer\Writer\Twig\RelativePathToRootConverter | $relativePathToRootConverter | |
\phpDocumentor\Transformer\Writer\Twig\PathBuilder | $pathBuilder |
getGlobals() : array{project: \phpDocumentor\Descriptor\ProjectDescriptor, documentationSet: \phpDocumentor\Descriptor\DocumentationSetDescriptor, node: ?\phpDocumentor\Descriptor\Descriptor, usesNamespaces: bool, usesPackages: bool, destinationPath: ?string, parameter: array<string,mixed>, env: mixed}
Initialize series of globals used by the writers to set the context
getFunctions() : \Twig\TwigFunction[]
Returns a listing of all functions that this extension adds.
This method is automatically used by Twig upon registering this extension (which is done automatically by phpDocumentor) to determine an additional list of functions.
See the Class' DocBlock for a listing of functionality added by this Extension.
renderRoute(array $context, \phpDocumentor\Reflection\Type[]|\phpDocumentor\Reflection\Type|\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference|\phpDocumentor\Path|string|iterable $value, string $presentation) : string[]|string
array | $context | |
\phpDocumentor\Reflection\Type[]|\phpDocumentor\Reflection\Type|\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference|\phpDocumentor\Path|string|iterable | $value | |
string | $presentation |
sort(string $direction, \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Descriptor> $collection) : \ArrayIterator<array-key,\phpDocumentor\Descriptor\Descriptor>
string | $direction | |
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Descriptor> | $collection |
sortByVisibility(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Descriptor> $collection) : \ArrayIterator<array-key,\phpDocumentor\Descriptor\Descriptor>
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Descriptor> | $collection |