$destination
$destination : string
Renders an HTML anchor pointing to the location of the provided element.
$routers : \phpDocumentor\Transformer\Router\Queue
__construct(\phpDocumentor\Transformer\Router\Queue $routers)
Initializes this renderer with a set of routers that are checked.
| \phpDocumentor\Transformer\Router\Queue | $routers |
setRouters(\phpDocumentor\Transformer\Router\Queue $routers) : void
Overwrites the associated routers with a new set of routers.
| \phpDocumentor\Transformer\Router\Queue | $routers |
getRouters() : \phpDocumentor\Transformer\Router\Queue
Returns the routers used in generating the URLs for the anchors.
setDestination(string $destination) : void
Sets the destination directory relative to the Project's Root.
The destination is the target directory containing the resulting file. This destination is relative to the Project's root and can be used for the calculation of nesting depths, etc.
For this specific extension the destination is provided in the Twig writer itself.
| string | $destination |
render(string|\phpDocumentor\Descriptor\DescriptorAbstract $value, string $presentation) : boolean|mixed|string|array<mixed,\string>
| string|\phpDocumentor\Descriptor\DescriptorAbstract | $value | |
| string | $presentation |
convertToRootPath(string $relative_path) : string
Converts the given path to be relative to the root of the documentation target directory.
It is not possible to use absolute paths in documentation templates since they may be used locally, or in a subfolder. As such we need to calculate the number of levels to go up from the current document's directory and then append the given path.
For example:
Suppose you are in <root>/classes/my/class.html and you want open
<root>/my/index.html then you provide 'my/index.html' to this method
and it will convert it into ../../my/index.html (<root>/classes/my is
two nesting levels until the root).This method does not try to normalize or optimize the paths in order to save on development time and performance, and because it adds no real value.
| string | $relative_path |
renderASeriesOfLinks(array|\Traversable|\phpDocumentor\Descriptor\Collection $value, string $presentation) : array<mixed,string>
Returns a series of anchors and strings for the given collection of routable items.
| array|\Traversable|\phpDocumentor\Descriptor\Collection | $value | |
| string | $presentation |
renderTypeCollection(\phpDocumentor\Descriptor\Type\CollectionDescriptor $value, string $presentation) : string
Renders the view representation for an array or collection.
| \phpDocumentor\Descriptor\Type\CollectionDescriptor | $value | |
| string | $presentation |