NodeDefinition
class NodeDefinition implements NodeParentInterface
Этот класс предоставляет удобный интерфейс для определения узла.
Методы
| __construct(string $name, NodeParentInterface $parent = null) | ||
| $this | setParent(NodeParentInterface $parent) Устанавливает родительский узел. |
|
| $this | info(string $info) Устанавливает сообщение info. |
|
| $this | example(string|array $example) Устанавливает пример конфигурации. |
|
| $this | attribute(string $key, mixed $value) Устанавливает атрибут узла. |
|
| NodeParentInterface|NodeBuilder|NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition|null | end() Возвращает родительский узел. |
|
| NodeInterface | getNode(bool $forceRootNode = false) Создаёт узел. |
|
| $this | defaultValue(mixed $value) Устанавливает значение по умолчанию. |
|
| $this | isRequired() Устанавливает узел как обязательный. |
|
| $this | setDeprecated(string $message = 'The child node "%node%" at path "%path%" is deprecated.') Устанавливает узел как устаревший. |
|
| $this | treatNullLike(mixed $value) Устанавливает эквивалентное значение, используемое, когда узел содержит null. |
|
| $this | treatTrueLike(mixed $value) Устанавливает эквивалентное значение, используемое, когда узел содержит true. |
|
| $this | treatFalseLike(mixed $value) Устанавливает эквивалентное значение, используемое, когда узел содержит false. |
|
| $this | defaultNull() Устанавливает null в качестве значения по умолчанию. |
|
| $this | defaultTrue() Устанавливает true в качестве значения по умолчанию. |
|
| $this | defaultFalse() Устанавливает false в качестве значения по умолчанию. |
|
| ExprBuilder | beforeNormalization() Устанавливает выражение, которое будет выполнено перед нормализацией. |
|
| $this | cannotBeEmpty() Запрещает пустое значение узла. |
|
| ExprBuilder | validate() Устанавливает выражение для проверки. |
|
| $this | cannotBeOverwritten(bool $deny = true) Устанавливает, может ли узел быть перезаписан. |
Детали
__construct(string $name, NodeParentInterface $parent = null)
Параметры
| string | $name | Имя узла |
| NodeParentInterface | $parent | Родительский узел |
$this setParent(NodeParentInterface $parent)
Устанавливает родительский узел.
Параметры
| NodeParentInterface | $parent |
Значение результата
| $this |
$this info(string $info)
Устанавливает сообщение информации.
Параметры
| string | $info | Текст сообщения |
Значение результата
| $this |
$this example(string|array $example)
Устанавливает пример конфигурации.
Параметры
| string|array | $example |
Значение результата
| $this |
$this attribute(string $key, mixed $value)
Устанавливает атрибут узла.
Параметры
| string | $key | |
| mixed | $value |
Значение результата
| $this |
NodeParentInterface|NodeBuilder|NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition|null end()
Возвращает родительский узел.
Значение результата
| NodeParentInterface|NodeBuilder|NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition|null | Создатель родительского узла |
NodeInterface getNode(bool $forceRootNode = false)
Создаёт узел.
Параметры
| bool | $forceRootNode | Принудительно назначить этот узел корневым узлом |
Значение результата
| NodeInterface |
$this defaultValue(mixed $value)
Устанавливает значение по умолчанию.
Параметры
| mixed | $value | Значение по умолчанию |
Значение результата
| $this |
$this isRequired()
Устанавливает узел как обязательный.
Значение результата
| $this |
$this setDeprecated(string $message = 'The child node "%node%" at path "%path%" is deprecated.')
Устанавливает узел как устаревший.
Вы можете использовать плейсхолдеры %node% и %path%, чтобы отобразить соответственно имя узла и его полный путь.
Параметры
| string | $message | Сообщение об устаревании |
Значение результата
| $this |
$this treatNullLike(mixed $value)
Устанавливает эквивалентное значение, используемое, когда узел содержит null.
Параметры
| mixed | $value |
Значение результата
| $this |
$this treatTrueLike(mixed $value)
Устанавливает эквивалентное значение, используемое, когда узел содержит true.
Параметры
| mixed | $value |
Значение результата
| $this |
$this treatFalseLike(mixed $value)
Устанавливает эквивалентное значение, используемое, когда узел содержит false.
Параметры
| mixed | $value |
Значение результата
| $this |
$this defaultNull()
Устанавливает null в качестве значения по умолчанию.
Значение результата
| $this |
$this defaultTrue()
Устанавливает true в качестве значения по умолчанию.
Значение результата
| $this |
$this defaultFalse()
Устанавливает false в качестве значения по умолчанию.
Значение результата
| $this |
ExprBuilder beforeNormalization()
Устанавливает выражение, которое выполняется перед нормализацией.
Значение результата
| ExprBuilder |
$this cannotBeEmpty()
Запрещает пустое значение узла.
Значение результата
| $this |
ExprBuilder validate()
Устанавливает выражение для проверки.
Выражение получает значение узла и должно вернуть его. Оно может его изменить. При невалидности узла должно быть выброшено исключение.
Значение результата
| ExprBuilder |
$this cannotBeOverwritten(bool $deny = true)
Устанавливает, может ли узел быть перезаписан.
Параметры
| bool | $deny | Запрещено ли перезаписывание |
Значение результата
| $this |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Config/Definition/Builder/NodeDefinition.html
