[ Index ]

PHP Cross Reference of phpBB-3.3.7-deutsch

title

Body

[close]

/vendor/symfony/config/Definition/Builder/ -> NodeDefinition.php (summary)

This class provides a fluent interface for defining a node.

Author: Johannes M. Schmitt <schmittjoh@gmail.com>
File Size: 353 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 23 functions

  __construct()
  setParent()
  info()
  example()
  attribute()
  end()
  getNode()
  defaultValue()
  isRequired()
  setDeprecated()
  treatNullLike()
  treatTrueLike()
  treatFalseLike()
  defaultNull()
  defaultTrue()
  defaultFalse()
  beforeNormalization()
  cannotBeEmpty()
  validate()
  cannotBeOverwritten()
  validation()
  merge()
  normalization()

Functions
Functions that are not part of a class:

__construct($name, NodeParentInterface $parent = null)   X-Ref

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

setParent(NodeParentInterface $parent)   X-Ref
Sets the parent node.

return: $this

info($info)   X-Ref
Sets info message.

param: string $info The info text
return: $this

example($example)   X-Ref
Sets example configuration.

param: string|array $example
return: $this

attribute($key, $value)   X-Ref
Sets an attribute on the node.

param: string $key
param: mixed  $value
return: $this

end()   X-Ref
Returns the parent node.

return: NodeParentInterface|NodeBuilder|NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition|null The builder of the parent node

getNode($forceRootNode = false)   X-Ref
Creates the node.

param: bool $forceRootNode Whether to force this node as the root node
return: NodeInterface

defaultValue($value)   X-Ref
Sets the default value.

param: mixed $value The default value
return: $this

isRequired()   X-Ref
Sets the node as required.

return: $this

setDeprecated($message = 'The child node "%node%" at path "%path%" is deprecated.')   X-Ref
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.

param: string $message Deprecation message
return: $this

treatNullLike($value)   X-Ref
Sets the equivalent value used when the node contains null.

param: mixed $value
return: $this

treatTrueLike($value)   X-Ref
Sets the equivalent value used when the node contains true.

param: mixed $value
return: $this

treatFalseLike($value)   X-Ref
Sets the equivalent value used when the node contains false.

param: mixed $value
return: $this

defaultNull()   X-Ref
Sets null as the default value.

return: $this

defaultTrue()   X-Ref
Sets true as the default value.

return: $this

defaultFalse()   X-Ref
Sets false as the default value.

return: $this

beforeNormalization()   X-Ref
Sets an expression to run before the normalization.

return: ExprBuilder

cannotBeEmpty()   X-Ref
Denies the node value being empty.

return: $this

validate()   X-Ref
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: ExprBuilder

cannotBeOverwritten($deny = true)   X-Ref
Sets whether the node can be overwritten.

param: bool $deny Whether the overwriting is forbidden or not
return: $this

validation()   X-Ref
Gets the builder for validation rules.

return: ValidationBuilder

merge()   X-Ref
Gets the builder for merging rules.

return: MergeBuilder

normalization()   X-Ref
Gets the builder for normalization rules.

return: NormalizationBuilder



Generated: Thu Mar 24 21:31:15 2022 Cross-referenced by PHPXref 0.7.1