phpDocumentor

Extension extends AbstractExtension
in package
implements ExtensionInterface, GlobalsInterface

FinalYes

Basic extension adding phpDocumentor specific functionality for Twig templates.

Global variables:

  • ast_node, the current $data element

Functions:

  • *path(string) *, converts the given relative path to be based of the projects root instead of the current directory

Filters:

  • markdown, converts the associated text from Markdown formatting to HTML.
  • trans, translates the given string
  • route, attempts to generate a URL for a given Descriptor
  • sort_desc, sorts the given objects by their Name property/getter in a descending fashion
  • sort_asc, sorts the given objects by their Name property/getter in a ascending fashion

Table of Contents

Interfaces

ExtensionInterface
An interface shared by all Twig interfaces intended for phpDocumentor.
GlobalsInterface

Properties

$documentationSet  : DocumentationSetDescriptor
$markdownConverter  : ConverterInterface
$pathBuilder  : PathBuilder
$project  : ProjectDescriptor
$relativePathToRootConverter  : RelativePathToRootConverter
$routeRenderer  : LinkRenderer

Methods

__construct()  : mixed
Registers the structure and transformation with this extension.
getFilters()  : array<string|int, TwigFilter>
Returns a list of all filters that are exposed by this extension.
getFunctions()  : array<string|int, TwigFunction>
Returns a listing of all functions that this extension adds.
getGlobals()  : Descriptor, usesNamespaces: bool, usesPackages: bool, destinationPath: ?string, parameter: array, env: mixed}
Initialize series of globals used by the writers to set the context
getTests()  : array<int, TwigTest>
renderDescription()  : string
renderRoute()  : array<string|int, string>|string
sort()  : ArrayIterator<string|int, Descriptor>
sortByVisibility()  : ArrayIterator<string|int, Descriptor>
contextRouteRenderer()  : LinkRenderer

Properties

$markdownConverter read-only

private ConverterInterface $markdownConverter

Methods

__construct()

Registers the structure and transformation with this extension.

public __construct(ProjectDescriptor $project, DocumentationSetDescriptor $documentationSet, ConverterInterface $markdownConverter, LinkRenderer $routeRenderer, RelativePathToRootConverter $relativePathToRootConverter, PathBuilder $pathBuilder) : mixed
Parameters
$project : ProjectDescriptor

Represents the complete Abstract Syntax Tree.

$documentationSet : DocumentationSetDescriptor
$markdownConverter : ConverterInterface
$routeRenderer : LinkRenderer
$relativePathToRootConverter : RelativePathToRootConverter
$pathBuilder : PathBuilder

getFilters()

Returns a list of all filters that are exposed by this extension.

public getFilters() : array<string|int, TwigFilter>
Return values
array<string|int, TwigFilter>

getFunctions()

Returns a listing of all functions that this extension adds.

public getFunctions() : array<string|int, TwigFunction>

This method is automatically used by Twig upon registering this extension (which is done automatically by phpDocumentor) to determine an additional list of functions.

See the Class' DocBlock for a listing of functionality added by this Extension.

Return values
array<string|int, TwigFunction>

getGlobals()

Initialize series of globals used by the writers to set the context

public getGlobals() : Descriptor, usesNamespaces: bool, usesPackages: bool, destinationPath: ?string, parameter: array, env: mixed}
Return values
Descriptor, usesNamespaces: bool, usesPackages: bool, destinationPath: ?string, parameter: array, env: mixed}

getTests()

public getTests() : array<int, TwigTest>
Return values
array<int, TwigTest>

renderRoute()

public renderRoute(array<string|int, mixed> $context, array<string|int, Type>|Type|DescriptorAbstract|Fqsen|Reference|Path|string|iterable<string|int, mixed> $value, string $presentation) : array<string|int, string>|string
Parameters
$context : array<string|int, mixed>
$value : array<string|int, Type>|Type|DescriptorAbstract|Fqsen|Reference|Path|string|iterable<string|int, mixed>
$presentation : string
Return values
array<string|int, string>|string

contextRouteRenderer()

private contextRouteRenderer(array<string|int, mixed> $context) : LinkRenderer
Parameters
$context : array<string|int, mixed>
Return values
LinkRenderer 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results