\phpDocumentor\DescriptorDocumentDescriptor

Summary

Methods
Properties
Constants
__construct()
getDocumentNode()
getHash()
getFile()
getTitle()
getTitles()
getTocs()
getDepends()
getLinks()
getVariables()
getName()
getDescription()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$documentNode
$hash
$file
$title
$titles
$tocs
$depends
$links
$variables
N/A

Properties

$documentNode

$documentNode : \phpDocumentor\Guides\Nodes\DocumentNode

Type

DocumentNode

$hash

$hash : string

Type

string

$file

$file : string

Type

string

$title

$title : string

Type

string

$titles

$titles : string[][]

Type

string[][]

$tocs

$tocs : \phpDocumentor\Guides\Nodes\TocNode[]

Type

TocNode[]

$depends

$depends : string[]

Type

string[]

$links

$links : string[]

Type

string[]

$variables

$variables : (string|\phpDocumentor\Guides\Nodes\SpanNode)[]

Type

SpanNode)[]

Methods

__construct()

__construct(\phpDocumentor\Guides\Nodes\DocumentNode  $documentNode, string  $hash, string  $file, string  $title, string[][]  $titles, \phpDocumentor\Guides\Nodes\TocNode[]  $tocs, string[]  $depends, string[]  $links, (string|\phpDocumentor\Guides\Nodes\SpanNode)[]  $variables) : mixed

Parameters

\phpDocumentor\Guides\Nodes\DocumentNode $documentNode
string $hash
string $file
string $title
string[][] $titles
\phpDocumentor\Guides\Nodes\TocNode[] $tocs
string[] $depends
string[] $links
(string|\phpDocumentor\Guides\Nodes\SpanNode)[] $variables

Returns

mixed —

getDocumentNode()

getDocumentNode() : \phpDocumentor\Guides\Nodes\DocumentNode

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —

getHash()

getHash() : string

Returns

string —

getFile()

getFile() : string

Returns

string —

getTitle()

getTitle() : string

Returns

string —

getTitles()

getTitles() : string[][]

Returns

string[][] —

getTocs()

getTocs() : \phpDocumentor\Guides\Nodes\TocNode[]

Returns

\phpDocumentor\Guides\Nodes\TocNode[] —

getDepends()

getDepends() : string[]

Returns

string[] —

getLinks()

getLinks() : string[]

Returns

string[] —

getVariables()

getVariables() : \phpDocumentor\Guides\Nodes\SpanNode[]|string[]

Returns variables collected during the parsing of s document.

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.

Returns

\phpDocumentor\Guides\Nodes\SpanNode[]|string[] —

getName()

getName() : string

Returns the local name for this element.

Returns

string —

getDescription()

getDescription() : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this element.

This method will automatically attempt to inherit the parent's description if this one has none.

Returns

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —