FloatNodeDefinition
class FloatNodeDefinition 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 | end() Возвращает родительский узел. | from NodeDefinition |
| NodeInterface | getNode(Boolean $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(Boolean $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 end()
Возвращает родительский узел.
Значение результата
| NodeParentInterface | Билдер родительского узла |
NodeInterface getNode(Boolean $forceRootNode = false)
Создает узел.
Параметры
| Boolean | $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(Boolean $deny = true)
Устанавливает, может ли узел быть перезаписан.
Параметры
| Boolean | $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/3.0/Symfony/Component/Config/Definition/Builder/FloatNodeDefinition.html