AbstractTabNode
extends GeneralDirectiveNode
in package
AbstractYes
A catch-all directive Node containing all information about the original directive in rst.
Table of Contents
Properties
- $classes : array<string|int, string>
- $content : InlineCompoundNode
- $name : string
- $options : array<string, scalar|null>
- $plainContent : string
- $value : TValue
- $active : bool
- $key : string
Methods
- __construct() : mixed
- addChildNode() : void
- getChildren() : array<string|int, TValue>
- getClasses() : array<string|int, string>
- getClassesString() : string
- getContent() : InlineCompoundNode
- getKey() : string
- getName() : string
- getOption() : mixed
- getOptions() : array<string, scalar|null>
- getPlainContent() : string
- getValue() : TValue
- hasOption() : bool
- isActive() : bool
- pushChildNode() : void
- removeNode() : self
- replaceNode() : self
- setActive() : void
- 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
Properties
$classes
protected
array<string|int, string>
$classes
= []
$content read-only
protected
InlineCompoundNode
$content
$name read-only
protected
string
$name
$options
protected
array<string, scalar|null>
$options
= []
$plainContent read-only
protected
string
$plainContent
$value
protected
TValue
$value
$active
private
bool
$active
$key read-only
private
string
$key
Methods
__construct()
public
__construct(string $name, string $plainContent, InlineCompoundNode $content, string $key, bool $active[, array<int, Node> $value = [] ]) : mixed
Parameters
- $name : string
- $plainContent : string
- $content : InlineCompoundNode
- $key : string
- $active : bool
- $value : array<int, Node> = []
addChildNode()
public
addChildNode(TValue $node) : void
Parameters
- $node : TValue
getChildren()
public
getChildren() : array<string|int, TValue>
Return values
array<string|int, TValue>getClasses()
public
getClasses() : array<string|int, string>
Return values
array<string|int, string>getClassesString()
public
getClassesString() : string
Return values
stringgetContent()
public
getContent() : InlineCompoundNode
Return values
InlineCompoundNodegetKey()
public
getKey() : string
Return values
stringgetName()
public
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|null>
Return values
array<string, scalar|null>getPlainContent()
public
getPlainContent() : string
Return values
stringgetValue()
public
getValue() : TValue
Return values
TValuehasOption()
public
hasOption(string $name) : bool
Parameters
- $name : string
Return values
boolisActive()
public
isActive() : bool
Return values
boolpushChildNode()
public
pushChildNode(TValue $node) : void
Parameters
- $node : TValue
removeNode()
public
removeNode(int $key) : self
Parameters
- $key : int
Tags
Return values
selfreplaceNode()
public
replaceNode(int $key, TValue $node) : self
Parameters
- $key : int
- $node : TValue
Tags
Return values
selfsetActive()
public
setActive(bool $active) : void
Parameters
- $active : bool
setClasses()
Normalizes class names following the rules of identifier-normalization
public
setClasses(array<string|int, string> $classes) : void
Parameters
- $classes : array<string|int, 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|null> $options) : static
Parameters
- $options : array<string, scalar|null>