Spec-Zone.ru › Symfony 2.8

EnumNodeDefinition

class EnumNodeDefinition extends ScalarNodeDefinition

Определение узла перечисления.

Методы

__construct(string $name, NodeParentInterface $parent = null) из NodeDefinition
$this setParent(NodeParentInterface $parent)

Устанавливает родительский узел.

из NodeDefinition
$this info(string $info)

Устанавливает сообщение информации.

из NodeDefinition
$this example(string|array $example)

Устанавливает пример конфигурации.

из NodeDefinition
$this attribute(string $key, mixed $value)

Устанавливает атрибут узла.

из NodeDefinition
NodeParentInterface|NodeBuilder|NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition|null end()

Возвращает родительский узел.

из NodeDefinition
NodeInterface getNode(bool $forceRootNode = false)

Создаёт узел.

из NodeDefinition
$this defaultValue(mixed $value)

Устанавливает значение по умолчанию.

из NodeDefinition
$this isRequired()

Устанавливает узел как обязательный.

из NodeDefinition
$this treatNullLike(mixed $value)

Устанавливает эквивалентное значение, используемое, когда узел содержит null.

из NodeDefinition
$this treatTrueLike(mixed $value)

Устанавливает эквивалентное значение, используемое, когда узел содержит true.

из NodeDefinition
$this treatFalseLike(mixed $value)

Устанавливает эквивалентное значение, используемое, когда узел содержит false.

из NodeDefinition
$this defaultNull()

Устанавливает null в качестве значения по умолчанию.

из NodeDefinition
$this defaultTrue()

Устанавливает true в качестве значения по умолчанию.

из NodeDefinition
$this defaultFalse()

Устанавливает false в качестве значения по умолчанию.

из NodeDefinition
ExprBuilder beforeNormalization()

Устанавливает выражение для выполнения перед нормализацией.

из NodeDefinition
$this cannotBeEmpty()

Запрещает пустое значение узла.

из NodeDefinition
ExprBuilder validate()

Устанавливает выражение для выполнения проверки.

из NodeDefinition
$this cannotBeOverwritten(bool $deny = true)

Устанавливает, можно ли перезаписывать узел.

из 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|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 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/2.8/Symfony/Component/Config/Definition/Builder/EnumNodeDefinition.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API