\phpDocumentor\Guides\TwigAssetsExtension

Summary

Methods
Properties
Constants
__construct()
getFunctions()
asset()
renderNode()
uml()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
copyAsset()
$logger
$plantumlRenderer
N/A

Properties

$logger

$logger : \Psr\Log\LoggerInterface

Type

\Psr\Log\LoggerInterface —

$plantumlRenderer

$plantumlRenderer : \phpDocumentor\Transformer\Writer\Graph\PlantumlRenderer

Type

PlantumlRenderer

Methods

__construct()

__construct(\Psr\Log\LoggerInterface  $logger, \phpDocumentor\Transformer\Writer\Graph\PlantumlRenderer  $plantumlRenderer) : mixed

Parameters

\Psr\Log\LoggerInterface $logger
\phpDocumentor\Transformer\Writer\Graph\PlantumlRenderer $plantumlRenderer

Returns

mixed —

getFunctions()

getFunctions() : array

Returns

array —

asset()

asset(array  $context, string  $path) : string

Copies the referenced asset and returns the canonical path to that asset; thus taking the BASE tag into account.

The layout for guides includes a BASE tag in the head, which creates the need for all relative urls to actually be relative not to the current file's path; but the root of the Documentation Set. This means that, when rendering paths, you always need to include the canonical path; not that relative to the current file.

Parameters

array $context
string $path

Returns

string —

renderNode()

renderNode(array  $context, \phpDocumentor\Guides\Nodes\Node  $node) : string

Parameters

array $context
\phpDocumentor\Guides\Nodes\Node $node

Returns

string —

uml()

uml(string  $source) : ?string

Parameters

string $source

Returns

?string —

copyAsset()

copyAsset(?\phpDocumentor\Guides\Environment  $environment, ?\League\Flysystem\FilesystemInterface  $destination, string  $path) : string

Parameters

?\phpDocumentor\Guides\Environment $environment
?\League\Flysystem\FilesystemInterface $destination
string $path

Returns

string —