phpDocumentor

DocumentDescriptor
in package
implements Descriptor

Interfaces, Classes and Traits

Descriptor
Base class for descriptors containing the most used options.

Table of Contents

$depends  : array<string|int, string>
$documentNode  : DocumentNode
$file  : string
$hash  : string
$links  : array<string|int, string>
$title  : string
$titles  : array<string|int, array<string|int, string>>
$tocs  : array<string|int, TocNode>
$variables  : array<string|int, string|\phpDocumentor\Guides\Nodes\SpanNode>
__construct()  : mixed
getDepends()  : array<string|int, string>
getDescription()  : DescriptionDescriptor|null
Returns the description for this element.
getDocumentNode()  : DocumentNode
getFile()  : string
getHash()  : string
getLinks()  : array<string|int, string>
getName()  : string
Returns the local name for this element.
getTitle()  : string
getTitles()  : array<string|int, array<string|int, string>>
getTocs()  : array<string|int, TocNode>
getVariables()  : array<string|int, SpanNode>|array<string|int, string>
Returns variables collected during the parsing of s document.

Properties

$variables

private array<string|int, string|\phpDocumentor\Guides\Nodes\SpanNode> $variables

Methods

__construct()

public __construct(DocumentNode $documentNode, string $hash, string $file, string $title, array<string|int, array<string|int, string>> $titles, array<string|int, TocNode$tocs, array<string|int, string> $depends, array<string|int, string> $links, array<string|int, string|\phpDocumentor\Guides\Nodes\SpanNode> $variables) : mixed
Parameters
$documentNode : DocumentNode
$hash : string
$file : string
$title : string
$titles : array<string|int, array<string|int, string>>
$tocs : array<string|int, TocNode>
$depends : array<string|int, string>
$links : array<string|int, string>
$variables : array<string|int, string|\phpDocumentor\Guides\Nodes\SpanNode>
Return values
mixed

getDepends()

public getDepends() : array<string|int, string>
Return values
array<string|int, string>
public getLinks() : array<string|int, string>
Return values
array<string|int, string>

getName()

Returns the local name for this element.

public getName() : string
Return values
string

getTitles()

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

getVariables()

Returns variables collected during the parsing of s document.

public getVariables() : array<string|int, SpanNode>|array<string|int, string>

The 'replace' directive, for example, stores the replacement as a variable on the Document. To be able to access the variables collected during parsing, we can store a series of variables here.

Return values
array<string|int, SpanNode>|array<string|int, string>

Search results