\phpDocumentor\Transformer\Writer\TwigLinkRenderer

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

Summary

Methods
Properties
Constants
__construct()
__clone()
withProject()
forDocumentationSet()
getProject()
getDocumentationSet()
withDestination()
getDestination()
supports()
render()
No public properties found
PRESENTATION_NONE
PRESENTATION_NORMAL
PRESENTATION_URL
PRESENTATION_CLASS_SHORT
PRESENTATION_FILE_SHORT
No protected methods found
No protected properties found
N/A
createAdapters()
$destination
$project
$documentationSet
$adapters
$router
$htmlFormatter
N/A

Constants

PRESENTATION_NONE

PRESENTATION_NONE = ''

PRESENTATION_NORMAL

PRESENTATION_NORMAL = 'normal'

PRESENTATION_URL

PRESENTATION_URL = 'url'

PRESENTATION_CLASS_SHORT

PRESENTATION_CLASS_SHORT = 'class:short'

PRESENTATION_FILE_SHORT

PRESENTATION_FILE_SHORT = 'file:short'

Properties

$destination

$destination : string

Type

string

$project

$project : \phpDocumentor\Descriptor\ProjectDescriptor

Type

\phpDocumentor\Descriptor\ProjectDescriptor

$documentationSet

$documentationSet : \phpDocumentor\Descriptor\DocumentationSetDescriptor

Type

\phpDocumentor\Descriptor\DocumentationSetDescriptor

$adapters

$adapters : \phpDocumentor\Transformer\Writer\Twig\LinkRendererInterface[]

Type

\phpDocumentor\Transformer\Writer\Twig\LinkRendererInterface[] —

$router

$router : \phpDocumentor\Transformer\Router\Router

Type

\phpDocumentor\Transformer\Router\Router

$htmlFormatter

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

Type

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

Methods

__construct()

__construct(\phpDocumentor\Transformer\Router\Router  $router, \phpDocumentor\Transformer\Writer\Twig\LinkRenderer\HtmlFormatter  $htmlFormatter) : mixed

Parameters

\phpDocumentor\Transformer\Router\Router $router
\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\HtmlFormatter $htmlFormatter

Returns

mixed —

__clone()

__clone() : mixed

Returns

mixed —

withProject()

withProject(\phpDocumentor\Descriptor\ProjectDescriptor  $projectDescriptor) : self

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $projectDescriptor

Returns

self —

forDocumentationSet()

forDocumentationSet(\phpDocumentor\Descriptor\DocumentationSetDescriptor  $documentationSet) : self

Parameters

\phpDocumentor\Descriptor\DocumentationSetDescriptor $documentationSet

Returns

self —

getProject()

getProject() : \phpDocumentor\Descriptor\ProjectDescriptor

Returns

\phpDocumentor\Descriptor\ProjectDescriptor —

getDocumentationSet()

getDocumentationSet() : \phpDocumentor\Descriptor\DocumentationSetDescriptor

Returns

\phpDocumentor\Descriptor\DocumentationSetDescriptor —

withDestination()

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.

Parameters

string $destination

Returns

self —

getDestination()

getDestination() : string

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

Returns

string —

supports()

supports(mixed  $value) : bool

Parameters

mixed $value

Returns

bool —

render()

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|list<string>

Parameters

\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

Returns

string|list

createAdapters()

createAdapters() : array<array-key,\phpDocumentor\Transformer\Writer\Twig\LinkRendererInterface>

Returns

array