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>
- __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>
Properties
$depends
private
array<string|int, string>
$depends
$documentNode
private
DocumentNode
$documentNode
$file
private
string
$file
$hash
private
string
$hash
$links
private
array<string|int, string>
$links
$title
private
string
$title
$titles
private
array<string|int, array<string|int, string>>
$titles
$tocs
private
array<string|int, TocNode>
$tocs
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) : 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>
Return values
mixed —getDepends()
public
getDepends() : array<string|int, string>
Return values
array<string|int, string> —getDescription()
Returns the description for this element.
public
getDescription() : DescriptionDescriptor|null
This method will automatically attempt to inherit the parent's description if this one has none.
Return values
DescriptionDescriptor|null —getDocumentNode()
public
getDocumentNode() : DocumentNode
Return values
DocumentNode —getFile()
public
getFile() : string
Return values
string —getHash()
public
getHash() : string
Return values
string —getLinks()
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 —getTitle()
public
getTitle() : string
Return values
string —getTitles()
public
getTitles() : array<string|int, array<string|int, string>>
Return values
array<string|int, array<string|int, string>> —getTocs()
public
getTocs() : array<string|int, TocNode>