PRESENTATION_NORMAL
PRESENTATION_NORMAL = 'normal'
Renders an HTML anchor pointing to the location of the provided element.
$destination : string
$router : \phpDocumentor\Transformer\Router\Router
$project : \phpDocumentor\Descriptor\ProjectDescriptor|null
$convertToRootPath : bool
withDestination(string $destination) : self
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 |
None found |
withProject(\phpDocumentor\Descriptor\ProjectDescriptor $projectDescriptor) : self
\phpDocumentor\Descriptor\ProjectDescriptor | $projectDescriptor |
None found |
None found |
getDestination() : string
Returns the target directory relative to the Project's Root.
None found |
link(\phpDocumentor\Descriptor\Descriptor|\phpDocumentor\Reflection\Fqsen|\League\Uri\Uri $value) : string
\phpDocumentor\Descriptor\Descriptor|\phpDocumentor\Reflection\Fqsen|\League\Uri\Uri | $value |
None found |
render(\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
\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 |
None found |
convertToRootPath(string $pathOrReference, bool $force = false) : ?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.
In addition, when a path starts with an @-sign, it is interpreted as a reference to a structural element and we use the router to try and find a path to which this refers.
string | $pathOrReference | |
bool | $force |
todo |
References can only point to an element that is a class, interface, trait, method, property or class constant at this moment. This is because an FQSEN does not contain the necessary data to distinguish whether the FQCN is actually a class or a namespace reference. As such we assume a class as that is the most common occurrence. |
---|
renderASeriesOfLinks(iterable $value, string $presentation) : \phpDocumentor\Transformer\Writer\Twig\list<string>
Returns a series of anchors and strings for the given collection of routable items.
iterable | $value | |
string | $presentation |
None found |
renderLink(string|\phpDocumentor\Path|\phpDocumentor\Reflection\Type|\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Fqsen $node, string $presentation) : string
string|\phpDocumentor\Path|\phpDocumentor\Reflection\Type|\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Fqsen | $node | |
string | $presentation |
None found |
renderType(iterable<\phpDocumentor\Reflection\Type> $value) : \phpDocumentor\Transformer\Writer\Twig\list<string>
iterable<\phpDocumentor\Reflection\Type> | $value |
None found |
getPathPrefixBasedOnDepth() : string
Calculates how deep the given destination is and returns a prefix.
The calculated prefix is used to get back to the root (i.e. three levels deep means ../../..
) or an empty
string is returned when you are already at the same level as the root.
This prefix will include a trailing forward slash (/) when it actually needs to direct the caller to go elsewhere.
None found |
None found |
withoutLeadingSlash(string $path) : string
string | $path |
None found |
createFqsenFromReference(string $path) : \phpDocumentor\Reflection\Fqsen
string | $path |
None found |
renderAbstractListLinks(\phpDocumentor\Reflection\Types\AbstractList $node, string $presentation) : string
\phpDocumentor\Reflection\Types\AbstractList | $node | |
string | $presentation |
None found |