\phpDocumentor\Transformer\Writer\Twig\LinkRendererLinkAdapter

Renders most of the links to elements, urls and urls with virtual schemes.

For more high level information on how references, see {@see doc://internals/rendering/links} that accompanies this feature.

Summary

Methods

Properties

Constants

__construct()
supports()
render()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

tryToResolveFqsenToDescriptor()
normalizePresentation()
determineTitle()

$rendererChain
$urlGenerator
$formatter

N/A

Properties

$rendererChain

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

Type

\phpDocumentor\Transformer\Writer\Twig\LinkRenderer

$urlGenerator

$urlGenerator : \phpDocumentor\Transformer\Writer\Twig\LinkRenderer\UrlGenerator

Type

\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\UrlGenerator

$formatter

$formatter : \phpDocumentor\Transformer\Writer\Twig\LinkRenderer\HtmlFormatter

Type

\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\HtmlFormatter

Methods

__construct()

__construct(\phpDocumentor\Transformer\Writer\Twig\LinkRenderer  $rendererChain, \phpDocumentor\Transformer\Writer\Twig\LinkRenderer\UrlGenerator  $urlGenerator, \phpDocumentor\Transformer\Writer\Twig\LinkRenderer\HtmlFormatter  $formatter) : mixed

Parameters

\phpDocumentor\Transformer\Writer\Twig\LinkRenderer	$rendererChain
\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\UrlGenerator	$urlGenerator
\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\HtmlFormatter	$formatter

Returns

mixed —

supports()

supports(mixed  $value) : bool

Parameters

mixed

$value

Returns

bool —

render()

render(mixed  $value, string  $presentation) : string|list<string>

Parameters

mixed	$value
string	$presentation

Returns

string|list —

tryToResolveFqsenToDescriptor()

tryToResolveFqsenToDescriptor(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|\phpDocumentor\Path|\phpDocumentor\Reflection\Type|\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference

Some passed types of value are references to an element; let's try to resolve these to a Descriptor.

Should we not be able to resolve this to a Descriptor, we return the passed object or an FQSEN that could not be resolved because the element is not in the API docs.

Parameters

$target

Returns

normalizePresentation()

normalizePresentation(string|\phpDocumentor\Path|\phpDocumentor\Reflection\Type|\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Fqsen  $resolvedTarget, string  $presentation) : 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	$resolvedTarget
string	$presentation

Returns

string —

determineTitle()

determineTitle(string|\phpDocumentor\Path|\phpDocumentor\Reflection\Type|\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference|\phpDocumentor\Reflection\DocBlock\Tags\Reference\Fqsen  $resolvedTarget) : string

Parameters

$resolvedTarget

Returns

string —