AnnotationInlineNode
extends InlineNode
in package
AbstractYes
This node an annotation, for example citation or footnote
Table of Contents
Properties
- $classes : string[]
- $internalTarget : InternalTarget|null
- $options : array<string, scalar|scalar[]|null>
- $value : TValue
Methods
- __construct() : mixed
- addMetaData() : void
- Attaches data about this node that is not part of its content.
- getClasses() : string[]
- getClassesString() : string
- getInternalTarget() : InternalTarget|null
- getMetaData() : array<string, DataNode>
- getName() : string
- getOption() : mixed
- getOptions() : array<string, scalar|scalar[]|null>
- getType() : string
- getValue() : TValue
- hasOption() : bool
- setClasses() : void
- Normalizes class names following the rules of identifier-normalization
- setInternalTarget() : void
- setValue() : void
- toString() : string
- withKeepExistingOptions() : static
- Adds $options as default options without overriding any options already set.
- withOptions() : static
Properties
$classes
protected
string[]
$classes
= []
$internalTarget
protected
InternalTarget|null
$internalTarget
= null
$options
protected
array<string, scalar|scalar[]|null>
$options
= []
$value
protected
TValue
$value
Methods
__construct()
public
__construct(string $type[, string $value = '' ]) : mixed
Parameters
- $type : string
- $value : string = ''
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
getClasses()
public
getClasses() : string[]
Return values
string[]getClassesString()
public
getClassesString() : string
Return values
stringgetInternalTarget()
public
getInternalTarget() : InternalTarget|null
Return values
InternalTarget|nullgetMetaData()
public
getMetaData() : array<string, DataNode>
Return values
array<string, DataNode> —keyed by name
getName()
public
abstract getName() : string
Return values
stringgetOption()
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>getType()
public
getType() : string
Return values
stringgetValue()
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
setInternalTarget()
public
setInternalTarget(InternalTarget|null $internalTarget) : void
Parameters
- $internalTarget : InternalTarget|null
setValue()
public
setValue(TValue $value) : void
Parameters
- $value : TValue
toString()
public
toString() : string
Return values
stringwithKeepExistingOptions()
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>