\phpDocumentor\Guides\NodesGenericNode

Any Directive not explicitly modeled.

To support custom directives, this node type will capture any Directive declaration not otherwise defined in a directive's node definition.

A generic node contains the name of the Directive (.. name::) and it can have options (:option:); in addition a value can be set after the directive invocation that can be read using the getValue() method.

Example:

.. name:: value of this directive
   :option: optionValue

Summary

Methods
Properties
Constants
__construct()
getValue()
setValue()
getClasses()
getClassesString()
setClasses()
getValueString()
withOptions()
getOptions()
getOption()
getName()
No public properties found
No constants found
normalizeLines()
$value
$classes
N/A
No private methods found
$options
$name
N/A

Properties

$classes

$classes : string[]

Type

string[]

$options

$options : array

Type

array

$name

$name : string

Type

string

Methods

__construct()

__construct(string  $name, \phpDocumentor\Guides\Nodes\Node|callable|string|null  $value = null) : mixed

Parameters

string $name
\phpDocumentor\Guides\Nodes\Node|callable|string|null $value

Returns

mixed —

getValue()

getValue() : \phpDocumentor\Guides\Nodes\Node|callable|string|null

Returns

\phpDocumentor\Guides\Nodes\Node|callable|string|null —

setValue()

setValue(\phpDocumentor\Guides\Nodes\Node|callable|string|null  $value) : void

Parameters

\phpDocumentor\Guides\Nodes\Node|callable|string|null $value

getClasses()

getClasses() : string[]

Returns

string[] —

getClassesString()

getClassesString() : string

Returns

string —

setClasses()

setClasses(string[]  $classes) : void

Parameters

string[] $classes

getValueString()

getValueString() : string

Returns

string —

withOptions()

withOptions(array<string,mixed>  $options) : self

Parameters

array $options

Returns

self —

getOptions()

getOptions() : array<string,mixed>

Returns

array

getOption()

getOption(string  $name, mixed|null  $default = null) : mixed|null

Parameters

string $name
mixed|null $default

Returns

mixed|null —

getName()

getName() : string

Returns

string —

normalizeLines()

normalizeLines(string[]  $lines) : string

Parameters

string[] $lines

Returns

string —