AuthorNode
extends AbstractNode
in package
FinalYes
The author element holds the name of the author of a document, section or code-block
Table of Contents
Constants
- CONTEXT_CODE : mixed = 'code'
- CONTEXT_DOCUMENT : mixed = 'document'
- CONTEXT_SECTION : mixed = 'section'
Properties
- $classes : string[]
- $options : array<string, scalar|scalar[]|null>
- $value : TValue
- $children : array
- $context : string
- $email : string|null
Methods
- __construct() : mixed
- addMetaData() : void
- Attaches data about this node that is not part of its content.
- getChildren() : Node[]
- getClasses() : string[]
- getClassesString() : string
- getContext() : string
- getEmail() : string|null
- getMetaData() : array<string, DataNode>
- getOption() : mixed
- getOptions() : array<string, scalar|scalar[]|null>
- getValue() : TValue
- hasOption() : bool
- setClasses() : void
- Normalizes class names following the rules of identifier-normalization
- setValue() : void
- withKeepExistingOptions() : static
- Adds $options as default options without overriding any options already set.
- withOptions() : static
Constants
CONTEXT_CODE
public
mixed
CONTEXT_CODE
= 'code'
CONTEXT_DOCUMENT
public
mixed
CONTEXT_DOCUMENT
= 'document'
CONTEXT_SECTION
public
mixed
CONTEXT_SECTION
= 'section'
Properties
$classes
protected
string[]
$classes
= []
$options
protected
array<string, scalar|scalar[]|null>
$options
= []
$value
protected
TValue
$value
$children read-only
private
array
$children
$context read-only
private
string
$context
= self::CONTEXT_DOCUMENT
private
string|null
$email
= null
Methods
__construct()
public
__construct(string $value, Node[] $children[, string $context = self::CONTEXT_DOCUMENT ][, string|null $email = null ]) : mixed
Parameters
- $value : string
- $children : Node[]
- $context : string = self::CONTEXT_DOCUMENT
- $email : string|null = null
addMetaData()
Attaches data about this node that is not part of its content.
public
addMetaData(DataNode $data) : void
Rendered as a data-* attribute where the node's template asks for
it. A name that is already taken gets the new values added to the ones
it has, rather than replaced by them. DataNode
Parameters
- $data : DataNode
getChildren()
public
getChildren() : Node[]
Return values
Node[]getClasses()
public
getClasses() : string[]
Return values
string[]getClassesString()
public
getClassesString() : string
Return values
stringgetContext()
public
getContext() : string
Return values
stringgetEmail()
public
getEmail() : string|null
Return values
string|nullgetMetaData()
public
getMetaData() : array<string, DataNode>
Return values
array<string, DataNode> —keyed by name
getOption()
public
getOption(string $name[, TType|null $default = null ]) : mixed
Parameters
- $name : string
- $default : TType|null = null
Tags
getOptions()
public
getOptions() : array<string, scalar|scalar[]|null>
Return values
array<string, scalar|scalar[]|null>getValue()
public
getValue() : TValue
Return values
TValuehasOption()
public
hasOption(string $name) : bool
Parameters
- $name : string
Return values
boolsetClasses()
Normalizes class names following the rules of identifier-normalization
public
setClasses(string[] $classes) : void
Parameters
- $classes : string[]
Tags
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|scalar[]|null> $options) : static
Parameters
- $options : array<string, scalar|scalar[]|null>