AssetsExtension
extends AbstractExtension
in package
FinalYes
Table of Contents
Properties
- $documentNameResolver : DocumentNameResolverInterface
- $logger : LoggerInterface
- $menuExtension : GlobalMenuExtension
- $nodeRenderer : NodeRenderer
- $urlGenerator : UrlGeneratorInterface
Methods
- __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, TwigFunction>
- getTests() : array<string|int, TwigTest>
- renderBreadcrumb() : string
- renderLink() : string
- renderMenu() : string
- renderNode() : string
- renderOrderedListType() : string
- renderTarget() : string
- copyAsset() : string
- getRenderContext() : RenderContext
Properties
$documentNameResolver read-only
private
DocumentNameResolverInterface
$documentNameResolver
$logger read-only
private
LoggerInterface
$logger
$menuExtension
private
GlobalMenuExtension
$menuExtension
$nodeRenderer read-only
private
NodeRenderer
$nodeRenderer
$urlGenerator read-only
private
UrlGeneratorInterface
$urlGenerator
Methods
__construct()
public
__construct(LoggerInterface $logger, NodeRenderer<string|int, Node> $nodeRenderer, DocumentNameResolverInterface $documentNameResolver, UrlGeneratorInterface $urlGenerator) : mixed
Parameters
- $logger : LoggerInterface
- $nodeRenderer : NodeRenderer<string|int, Node>
- $documentNameResolver : DocumentNameResolverInterface
- $urlGenerator : UrlGeneratorInterface
asset()
Copies the referenced asset and returns the canonical path to that asset; thus taking the BASE tag into account.
public
asset(RenderContext} $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 : RenderContext}
- $path : string
Return values
stringgetFunctions()
public
getFunctions() : array<string|int, TwigFunction>
Return values
array<string|int, TwigFunction>getTests()
public
getTests() : array<string|int, TwigTest>
Return values
array<string|int, TwigTest>renderBreadcrumb()
public
renderBreadcrumb(RenderContext} $context) : string
Parameters
- $context : RenderContext}
Return values
stringrenderLink()
public
renderLink(RenderContext} $context, string $url[, string|null $anchor = null ]) : string
Parameters
- $context : RenderContext}
- $url : string
- $anchor : string|null = null
Return values
stringrenderMenu()
public
renderMenu(RenderContext} $context, string $menuType[, int $maxMenuCount = 0 ]) : string
Parameters
- $context : RenderContext}
- $menuType : string
- $maxMenuCount : int = 0
Return values
stringrenderNode()
public
renderNode(RenderContext} $context, Node|array<string|int, Node>|null $node) : string
Parameters
Return values
stringrenderOrderedListType()
public
renderOrderedListType(string $listType) : string
Parameters
- $listType : string
Return values
stringrenderTarget()
public
renderTarget(RenderContext} $context, Target $target) : string
Parameters
- $context : RenderContext}
- $target : Target
Return values
stringcopyAsset()
private
copyAsset(RenderContext|null $renderContext, string $sourcePath) : string
Parameters
- $renderContext : RenderContext|null
- $sourcePath : string
Return values
stringgetRenderContext()
private
getRenderContext(RenderContext} $context) : RenderContext
Parameters
- $context : RenderContext}