[ Index ]

PHP Cross Reference of phpBB-3.3.12-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.

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

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

return: $this
param: string|array $example

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

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

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.

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

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

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

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.

return: $this
param: string $message Deprecation message

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

return: $this
param: mixed $value

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

return: $this
param: mixed $value

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

return: $this
param: mixed $value

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.

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

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: Sun Jun 23 12:25:44 2024 Cross-referenced by PHPXref 0.7.1