abstract class NodeDefinition implements NodeParentInterface

This class provides a fluent interface for defining a node.

Properties

protected $name
protected $normalization
protected $validation
protected $defaultValue
protected $default
protected $required
protected $deprecationMessage
protected $merge
protected $allowEmptyValue
protected $nullEquivalent
protected $trueEquivalent
protected $falseEquivalent
protected $parent
protected $attributes

Methods

__construct(string|null $name, NodeParentInterface $parent = null)

No description

$this
setParent(NodeParentInterface $parent)

Sets the parent node.

$this
info(string $info)

Sets info message.

$this
example(string|array $example)

Sets example configuration.

$this
attribute(string $key, mixed $value)

Sets an attribute on the node.

getNode(bool $forceRootNode = false)

Creates the node.

$this
defaultValue(mixed $value)

Sets the default value.

$this
isRequired()

Sets the node as required.

$this
setDeprecated(string $message = 'The child node "%node%" at path "%path%" is deprecated.')

Sets the node as deprecated.

$this
treatNullLike(mixed $value)

Sets the equivalent value used when the node contains null.

$this
treatTrueLike(mixed $value)

Sets the equivalent value used when the node contains true.

$this
treatFalseLike(mixed $value)

Sets the equivalent value used when the node contains false.

$this
defaultNull()

Sets null as the default value.

$this
defaultTrue()

Sets true as the default value.

$this
defaultFalse()

Sets false as the default value.

beforeNormalization()

Sets an expression to run before the normalization.

$this
cannotBeEmpty()

Denies the node value being empty.

validate()

Sets an expression to run for the validation.

$this
cannotBeOverwritten(bool $deny = true)

Sets whether the node can be overwritten.

validation()

Gets the builder for validation rules.

merge()

Gets the builder for merging rules.

normalization()

Gets the builder for normalization rules.

createNode()

Instantiate and configure the node according to this definition.

Details

at line 43
__construct(string|null $name, NodeParentInterface $parent = null)

Parameters

string|null $name The name of the node
NodeParentInterface $parent The parent

at line 54
$this setParent(NodeParentInterface $parent)

Sets the parent node.

Parameters

NodeParentInterface $parent

Return Value

$this

at line 68
$this info(string $info)

Sets info message.

Parameters

string $info The info text

Return Value

$this

at line 80
$this example(string|array $example)

Sets example configuration.

Parameters

string|array $example

Return Value

$this

at line 93
$this attribute(string $key, mixed $value)

Sets an attribute on the node.

Parameters

string $key
mixed $value

Return Value

$this

at line 117
NodeInterface getNode(bool $forceRootNode = false)

Creates the node.

Parameters

bool $forceRootNode Whether to force this node as the root node

Return Value

NodeInterface

at line 144
$this defaultValue(mixed $value)

Sets the default value.

Parameters

mixed $value The default value

Return Value

$this

at line 157
$this isRequired()

Sets the node as required.

Return Value

$this

at line 174
$this setDeprecated(string $message = 'The child node "%node%" at path "%path%" is deprecated.')

Sets the node as deprecated.

You can use %node% and %path% placeholders in your message to display, respectively, the node name and its complete path.

Parameters

string $message Deprecation message

Return Value

$this

at line 188
$this treatNullLike(mixed $value)

Sets the equivalent value used when the node contains null.

Parameters

mixed $value

Return Value

$this

at line 202
$this treatTrueLike(mixed $value)

Sets the equivalent value used when the node contains true.

Parameters

mixed $value

Return Value

$this

at line 216
$this treatFalseLike(mixed $value)

Sets the equivalent value used when the node contains false.

Parameters

mixed $value

Return Value

$this

at line 228
$this defaultNull()

Sets null as the default value.

Return Value

$this

at line 238
$this defaultTrue()

Sets true as the default value.

Return Value

$this

at line 248
$this defaultFalse()

Sets false as the default value.

Return Value

$this

at line 258
ExprBuilder beforeNormalization()

Sets an expression to run before the normalization.

Return Value

ExprBuilder

at line 268
$this cannotBeEmpty()

Denies the node value being empty.

Return Value

$this

at line 284
ExprBuilder validate()

Sets an expression to run for the validation.

The expression receives the value of the node and must return it. It can modify it. An exception should be thrown when the node is not valid.

Return Value

ExprBuilder

at line 296
$this cannotBeOverwritten(bool $deny = true)

Sets whether the node can be overwritten.

Parameters

bool $deny Whether the overwriting is forbidden or not

Return Value

$this

at line 308
protected ValidationBuilder validation()

Gets the builder for validation rules.

Return Value

ValidationBuilder

at line 322
protected MergeBuilder merge()

Gets the builder for merging rules.

Return Value

MergeBuilder

at line 336
protected NormalizationBuilder normalization()

Gets the builder for normalization rules.

Return Value

NormalizationBuilder

at line 352
abstract protected NodeInterface createNode()

Instantiate and configure the node according to this definition.

Return Value

NodeInterface The node instance

Exceptions

InvalidDefinitionException When the definition is invalid