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