phpDocumentor

AssetsExtension extends AbstractExtension
in package

Table of Contents

$logger  : LoggerInterface
$plantumlRenderer  : PlantumlRenderer
__construct()  : mixed
asset()  : string
Copies the referenced asset and returns the canonical path to that asset; thus taking the BASE tag into account.
getFunctions()  : array<string|int, mixed>
renderNode()  : string
uml()  : string|null
copyAsset()  : string

Properties

Methods

asset()

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

public asset(array<string|int, mixed> $context, string $path) : string

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
$context : array<string|int, mixed>
$path : string
Return values
string

getFunctions()

public getFunctions() : array<string|int, mixed>
Return values
array<string|int, mixed>

renderNode()

public renderNode(array<string|int, mixed> $context, Node $node) : string
Parameters
$context : array<string|int, mixed>
$node : Node
Return values
string

uml()

public uml(string $source) : string|null
Parameters
$source : string
Return values
string|null

copyAsset()

private copyAsset(Environment|null $environment, FilesystemInterface|null $destination, string $path) : string
Parameters
$environment : Environment|null
$destination : FilesystemInterface|null
$path : string
Return values
string

Search results