ScalarNodeDefinition
class ScalarNodeDefinition extends VariableNodeDefinition
Этот класс предоставляет удобный интерфейс для определения узла.
Свойства
| protected | $name | из NodeDefinition | |
| protected | $normalization | из NodeDefinition | |
| protected | $validation | из NodeDefinition | |
| protected | $defaultValue | из NodeDefinition | |
| protected | $default | из NodeDefinition | |
| protected | $required | из NodeDefinition | |
| protected | $deprecationMessage | из NodeDefinition | |
| protected | $merge | из NodeDefinition | |
| protected | $allowEmptyValue | из NodeDefinition | |
| protected | $nullEquivalent | из NodeDefinition | |
| protected | $trueEquivalent | из NodeDefinition | |
| protected | $falseEquivalent | из NodeDefinition | |
| protected | $pathSeparator | из NodeDefinition | |
| protected | $parent | из NodeDefinition | |
| protected | $attributes | из NodeDefinition |
Методы
| __construct(string|null $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|ArrayNodeDefinition|VariableNodeDefinition|null | end() Возвращает родительский узел. | from NodeDefinition |
| NodeInterface | getNode(bool $forceRootNode = false) Создает узел. | from NodeDefinition |
| $this | defaultValue(mixed $value) Устанавливает значение по умолчанию. | from NodeDefinition |
| $this | isRequired() Устанавливает узел как обязательный. | from NodeDefinition |
| $this | setDeprecated(string $message = 'The child node "%node%" at path "%path%" is deprecated.') Устанавливает узел как устаревший. | 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() Запрещает пустое значение узла. | from NodeDefinition |
| ExprBuilder | validate() Устанавливает выражение для выполнения проверки. | from NodeDefinition |
| $this | cannotBeOverwritten(bool $deny = true) Устанавливает, может ли узел быть перезаписан. | from NodeDefinition |
| ValidationBuilder | validation() Получает конструктор для правил проверки. | from NodeDefinition |
| MergeBuilder | merge() Получает конструктор для правил слияния. | from NodeDefinition |
| NormalizationBuilder | normalization() Получает конструктор для правил нормализации. | from NodeDefinition |
| NodeInterface | createNode() Инициализирует и настраивает узел в соответствии с этим определением. | from VariableNodeDefinition |
| $this | setPathSeparator(string $separator) Устанавливает разделитель пути. | from NodeDefinition |
| VariableNode | instantiateNode() Инициализирует узел. |
Подробности
__construct(string|null $name, NodeParentInterface $parent = null)
Параметры
| string|null | $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 setDeprecated(string $message = 'The child node "%node%" at path "%path%" is deprecated.')
Устанавливает узел как устаревший.
Вы можете использовать %node% и %path% в качестве заготовок в своем сообщении, чтобы отобразить соответственно имя узла и его полный путь.
Параметры
| string | $message | Сообщение об устаревании |
Возвращаемое значение
| $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 |
protected ValidationBuilder validation()
Получает создатель правил валидации.
Возвращаемое значение
| ValidationBuilder |
protected MergeBuilder merge()
Получает создатель правил слияния.
Возвращаемое значение
| MergeBuilder |
protected NormalizationBuilder normalization()
Получает создатель правил нормализации.
Возвращаемое значение
| NormalizationBuilder |
protected NodeInterface createNode()
Инициализирует и настраивает узел в соответствии с этим определением.
Возвращаемое значение
| NodeInterface | $node Экземпляр узла |
Исключения
| InvalidDefinitionException | Если определение некорректно |
$this setPathSeparator(string $separator)
Установить разделитель пути.
Параметры
| string | $separator |
Возвращаемое значение
| $this |
protected VariableNode instantiateNode()
Инициализировать узел.
Возвращаемое значение
| VariableNode | Узел |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Config/Definition/Builder/ScalarNodeDefinition.html
