BaseNode

__construct(string $name, NodeInterface $parent = null)

Parameters

string	$name	The name of the node
NodeInterface	$parent	The parent of this node

Exceptions

InvalidArgumentException

if the name contains a period

setAttribute($key, $value)

Parameters

	$key
	$value

getAttribute($key, $default = null)

Parameters

	$key
	$default

hasAttribute($key)

Parameters

$key

getAttributes()

setAttributes(array $attributes)

Parameters

array

$attributes

removeAttribute($key)

Parameters

$key

setInfo(string $info)

Sets an info message.

Parameters

string

$info

string getInfo()

Returns info message.

Return Value

string

The info text

setExample(string|array $example)

Sets the example configuration for this node.

Parameters

string|array

$example

string|array getExample()

Retrieves the example configuration for this node.

Return Value

string|array

The example

addEquivalentValue(mixed $originalValue, mixed $equivalentValue)

Adds an equivalent value.

Parameters

mixed	$originalValue
mixed	$equivalentValue

setRequired(bool $boolean)

Set this node as required.

Parameters

bool

$boolean

Required node

setAllowOverwrite(bool $allow)

Sets if this node can be overridden.

Parameters

bool

$allow

setNormalizationClosures(array $closures)

Sets the closures used for normalization.

Parameters

array

$closures

An array of Closures used for normalization

setFinalValidationClosures(array $closures)

Sets the closures used for final validation.

Parameters

array

$closures

An array of Closures used for final validation

bool isRequired()

Checks if this node is required.

Return Value

bool	If the node is required

string getName()

Returns the name of this node.

Return Value

string

The name of the node

string getPath()

Retrieves the path of this node.

Return Value

string

The node path

final mixed merge(mixed $leftSide, mixed $rightSide)

Merges two values together.

Parameters

mixed	$leftSide
mixed	$rightSide

Return Value

mixed

The merged values

Exceptions

ForbiddenOverwriteException

final mixed normalize(mixed $value)

Normalizes a value, applying all normalization closures.

Parameters

mixed

$value

The value to normalize

Return Value

mixed

The normalized value

NodeInterface|null getParent()

Returns parent node for this node.

Return Value

NodeInterface|null

final mixed finalize(mixed $value)

Finalizes a value, applying all finalization closures.

Parameters

mixed

$value

The value to finalize

Return Value

mixed

The finalized value

Exceptions

Exception
InvalidConfigurationException