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