NumericNodeDefinition
class NumericNodeDefinition 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() deprecated Запрещает значение узла быть пустым. | |
| ExprBuilder | validate() Устанавливает выражение для выполнения валидации. | from NodeDefinition |
| $this | cannotBeOverwritten(bool $deny = true) Устанавливает, можно ли перезаписывать узел. | from NodeDefinition |
| $this | max(mixed $max) Обеспечивает, что значение меньше заданной ссылки. | |
| $this | min(mixed $min) Обеспечивает, что значение больше заданной ссылки. |
Подробности
__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 max(mixed $max)
Убеждается, что значение меньше заданного значения.
Параметры
| mixed | $max |
Значение возврата
| $this |
Исключения
| InvalidArgumentException | при несовместимости ограничения |
$this min(mixed $min)
Убеждается, что значение больше заданного значения.
Параметры
| mixed | $min |
Значение возврата
| $this |
Исключения
| InvalidArgumentException | при несовместимости ограничения |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Config/Definition/Builder/NumericNodeDefinition.html
