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