Spec-Zone.ru › Symfony 3.0

EnumNodeDefinition

class EnumNodeDefinition extends ScalarNodeDefinition

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

Методы

__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
EnumNodeDefinition|$this values(array $values)

Подробности

__construct(string $name, NodeParentInterface $parent = null)

Конструктор.

Параметры

string $name Имя узла
NodeParentInterface $parent Родительский узел

NodeDefinition|$this setParent(NodeParentInterface $parent)

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

Параметры

NodeParentInterface $parent Родительский узел

Значение возврата

NodeDefinition|$this

NodeDefinition|$this info(string $info)

Устанавливает сообщение info.

Параметры

string $info Текст сообщения 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

EnumNodeDefinition|$this values(array $values)

Параметры

array $values

Значение возврата

EnumNodeDefinition|$this

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Config/Definition/Builder/EnumNodeDefinition.html

Spec-Zone.ru

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