LinkRenderer

in package

Renders an HTML anchor pointing to the location of the provided element.

LinkRenderer.php

Constants

Properties

private$destination  : string                

private$router  : \phpDocumentor\Transformer\Router\Router                

private$project  : \phpDocumentor\Descriptor\ProjectDescriptor|null

Methods

public__construct(Router $router) : mixed

Parameters

$router : Router

Returns

mixed — 

publicsetDestination(string $destination) : void

Parameters

$destination : string
deprecated

in favour of withDestination()

Sets the destination directory relative to the Project's Root.

publicwithDestination(string $destination) : self

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.

Parameters

$destination : string

Returns

self — 

publicwithProject(ProjectDescriptor $projectDescriptor) : self

Parameters

$projectDescriptor : ProjectDescriptor

Returns

self —

Returns the target directory relative to the Project's Root.

publicgetDestination() : string

Returns

string — 

publiclink(Descriptor|Fqsen|Uri $value) : string

Parameters

$value : Descriptor|Fqsen|Uri

Returns

string — 

publicrender(\phpDocumentor\Reflection\Type[]|Type|Descriptor|Fqsen|Path|string|iterable $value, string $presentation) : string[]|string

Parameters

$value : \phpDocumentor\Reflection\Type[]|Type|Descriptor|Fqsen|Path|string|iterable
$presentation : string

Returns

string[]|string —

Converts the given path to be relative to the root of the documentation target directory.

publicconvertToRootPath(string $pathOrReference) : string|null

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.

Parameters

$pathOrReference : string

Returns

string|null —
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.

Returns a series of anchors and strings for the given collection of routable items.

privaterenderASeriesOfLinks(iterable $value, string $presentation) : list

Parameters

$value : iterable
$presentation : string

Returns

list — 

privaterenderLink(string|Path|Object_|Descriptor|Fqsen $node, string $presentation) : string

Parameters

$node : string|Path|Object_|Descriptor|Fqsen
$presentation : string

Returns

string — 

privaterenderType(iterable $value) : list

Parameters

$value : iterable

Returns

list —

Calculates how deep the given destination is and returns a prefix.

privategetPathPrefixBasedOnDepth() : string

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.

Returns

string — 

privateisReferenceToFqsen(string $path) : bool

Parameters

$path : string

Returns

bool — 

privatewithoutLeadingSlash(string $path) : string

Parameters

$path : string

Returns

string — 

privatecreateFqsenFromReference(string $path) : Fqsen

Parameters

$path : string

Returns

Fqsen —