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