DocumentEntryNode
extends EntryNode
in package
FinalYes
Table of Contents
Properties
- $classes : array<string|int, string>
- $options : array<string, scalar|null>
- $value : TValue
- $additionalData : array<string|int, mixed>
- $entries : array<string|int, DocumentEntryNode|ExternalEntryNode>
- $file : string
- $isRoot : bool
- $parent : DocumentEntryNode|null
- $sections : array<string|int, SectionEntryNode>
- $titleNode : TitleNode
Methods
- __construct() : mixed
- addAdditionalData() : void
- addChild() : void
- addSection() : void
- findSectionEntry() : SectionEntryNode|null
- getAdditionalData() : Node|null
- getChildren() : array<string|int, DocumentEntryNode>
- getClasses() : array<string|int, string>
- getClassesString() : string
- getFile() : string
- getMenuEntries() : array<string|int, DocumentEntryNode|ExternalEntryNode>
- getOption() : mixed
- getOptions() : array<string, scalar|null>
- getParent() : DocumentEntryNode|null
- getSections() : array<string|int, SectionEntryNode>
- getTitle() : TitleNode
- getValue() : TValue
- hasOption() : bool
- isRoot() : bool
- setClasses() : void
- Normalizes class names following the rules of identifier-normalization
- setParent() : void
- setValue() : void
- withKeepExistingOptions() : static
- Adds $options as default options without overriding any options already set.
- withOptions() : static
Properties
$classes
protected
array<string|int, string>
$classes
= []
$options
protected
array<string, scalar|null>
$options
= []
$value
protected
TValue
$value
$additionalData
private
array<string|int, mixed>
$additionalData
= []
$entries
private
array<string|int, DocumentEntryNode|ExternalEntryNode>
$entries
= []
$file read-only
private
string
$file
$isRoot read-only
private
bool
$isRoot
= false
$parent
private
DocumentEntryNode|null
$parent
= null
$sections
private
array<string|int, SectionEntryNode>
$sections
= []
$titleNode read-only
private
TitleNode
$titleNode
Methods
__construct()
public
__construct(string $file, TitleNode $titleNode[, bool $isRoot = false ][, array<string, Node> $additionalData = [] ]) : mixed
Parameters
addAdditionalData()
public
addAdditionalData(string $key, Node $value) : void
Parameters
- $key : string
- $value : Node
addChild()
public
addChild(DocumentEntryNode|ExternalEntryNode $child) : void
Parameters
- $child : DocumentEntryNode|ExternalEntryNode
addSection()
public
addSection(SectionEntryNode $section) : void
Parameters
- $section : SectionEntryNode
findSectionEntry()
public
findSectionEntry(SectionNode $sectionNode) : SectionEntryNode|null
Parameters
- $sectionNode : SectionNode
Return values
SectionEntryNode|nullgetAdditionalData()
public
getAdditionalData(string $key) : Node|null
Parameters
- $key : string
Return values
Node|nullgetChildren()
public
getChildren() : array<string|int, DocumentEntryNode>
Return values
array<string|int, DocumentEntryNode>getClasses()
public
getClasses() : array<string|int, string>
Return values
array<string|int, string>getClassesString()
public
getClassesString() : string
Return values
stringgetFile()
public
getFile() : string
Return values
stringgetMenuEntries()
public
getMenuEntries() : array<string|int, DocumentEntryNode|ExternalEntryNode>
Return values
array<string|int, DocumentEntryNode|ExternalEntryNode>getOption()
public
getOption(string $name[, TType|null $default = null ]) : mixed
Parameters
- $name : string
- $default : TType|null = null
Tags
getOptions()
public
getOptions() : array<string, scalar|null>
Return values
array<string, scalar|null>getParent()
public
getParent() : DocumentEntryNode|null
Return values
DocumentEntryNode|nullgetSections()
public
getSections() : array<string|int, SectionEntryNode>
Return values
array<string|int, SectionEntryNode>getTitle()
public
getTitle() : TitleNode
Return values
TitleNodegetValue()
public
getValue() : TValue
Return values
TValuehasOption()
public
hasOption(string $name) : bool
Parameters
- $name : string
Return values
boolisRoot()
public
isRoot() : bool
Return values
boolsetClasses()
Normalizes class names following the rules of identifier-normalization
public
setClasses(array<string|int, string> $classes) : void
Parameters
- $classes : array<string|int, string>
Tags
setParent()
public
setParent(DocumentEntryNode|null $parent) : void
Parameters
- $parent : DocumentEntryNode|null
setValue()
public
setValue(TValue $value) : void
Parameters
- $value : TValue
withKeepExistingOptions()
Adds $options as default options without overriding any options already set.
public
withKeepExistingOptions(array<string, scalar|null> $options) : static
Parameters
- $options : array<string, scalar|null>
Return values
staticwithOptions()
public
withOptions(array<string, scalar|null> $options) : static
Parameters
- $options : array<string, scalar|null>