ScalarNodeDefinition
class ScalarNodeDefinition extends VariableNodeDefinition
Этот класс предоставляет удобный интерфейс для определения узла.
Методы
| __construct(string $name, NodeParentInterface $parent = null) Конструктор. | from NodeDefinition | |
| NodeDefinition|$this | setParent(NodeParentInterface $parent) Устанавливает родительский узел. | from NodeDefinition |
| NodeDefinition|$this | info(string $info) Устанавливает сообщение с информацией. | from NodeDefinition |
| NodeDefinition|$this | example(string|array $example) Устанавливает пример конфигурации. | from NodeDefinition |
| NodeDefinition|$this | attribute(string $key, mixed $value) Устанавливает атрибут узла. | from NodeDefinition |
| NodeParentInterface|null | end() Возвращает родительский узел. | from NodeDefinition |
| NodeInterface | getNode(bool $forceRootNode = false) Создаёт узел. | from NodeDefinition |
| NodeDefinition|$this | defaultValue(mixed $value) Устанавливает значение по умолчанию. | from NodeDefinition |
| NodeDefinition|$this | isRequired() Устанавливает узел как обязательный. | from NodeDefinition |
| NodeDefinition|$this | treatNullLike(mixed $value) Устанавливает эквивалентное значение, используемое, когда узел содержит null. | from NodeDefinition |
| NodeDefinition|$this | treatTrueLike(mixed $value) Устанавливает эквивалентное значение, используемое, когда узел содержит true. | from NodeDefinition |
| NodeDefinition|$this | treatFalseLike(mixed $value) Устанавливает эквивалентное значение, используемое, когда узел содержит false. | from NodeDefinition |
| NodeDefinition|$this | defaultNull() Устанавливает null в качестве значения по умолчанию. | from NodeDefinition |
| NodeDefinition|$this | defaultTrue() Устанавливает true в качестве значения по умолчанию. | from NodeDefinition |
| NodeDefinition|$this | defaultFalse() Устанавливает false в качестве значения по умолчанию. | from NodeDefinition |
| ExprBuilder | beforeNormalization() Устанавливает выражение, выполняемое перед нормализацией. | from NodeDefinition |
| NodeDefinition|$this | cannotBeEmpty() Запрещает пустое значение узла. | from NodeDefinition |
| ExprBuilder | validate() Устанавливает выражение для проверки. | from NodeDefinition |
| NodeDefinition|$this | cannotBeOverwritten(bool $deny = true) Устанавливает, может ли узел перезаписываться. | from 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/ScalarNodeDefinition.html
