NodeInterface
интерфейс NodeInterface
Общий интерфейс для всех узлов.
В большинстве случаев лучше наследовать от BaseNode, чем реализовывать этот интерфейс самостоятельно.
Методы
| string | getName() Возвращает имя узла. | |
| string | getPath() Возвращает путь узла. | |
| bool | isRequired() Возвращает true, если узел обязателен. | |
| bool | hasDefaultValue() Возвращает true, если узел имеет значение по умолчанию. | |
| mixed | getDefaultValue() Возвращает значение по умолчанию узла. | |
| mixed | normalize(mixed $value) Нормализует значение. | |
| mixed | merge(mixed $leftSide, mixed $rightSide) Объединяет два значения вместе. | |
| mixed | finalize(mixed $value) Завершает обработку значения. |
Подробности
string getName()
Возвращает имя узла.
Значение возврата
| string | Имя узла |
string getPath()
Возвращает путь узла.
Значение возврата
| string | Путь узла |
bool isRequired()
Возвращает true, если узел обязателен.
Значение возврата
| bool | Является ли узел обязательным |
bool hasDefaultValue()
Возвращает true, если узел имеет значение по умолчанию.
Значение возврата
| bool | Имеет ли узел значение по умолчанию |
mixed getDefaultValue()
Возвращает значение по умолчанию узла.
Значение возврата
| mixed | Значение по умолчанию |
Исключения
| RuntimeException | если узел не имеет значения по умолчанию |
mixed normalize(mixed $value)
Нормализует значение.
Параметры
| mixed | $value | Значение для нормализации |
Значение возврата
| mixed | Нормализованное значение |
Исключения
| InvalidTypeException | если тип значения неверен |
mixed merge(mixed $leftSide, mixed $rightSide)
Объединяет два значения вместе.
Параметры
| mixed | $leftSide | |
| mixed | $rightSide |
Значение возврата
| mixed | Объединенное значение |
Исключения
| ForbiddenOverwriteException | если путь конфигурации не может быть перезаписан |
| InvalidTypeException | если тип значения неверен |
mixed finalize(mixed $value)
Завершает обработку значения.
Параметры
| mixed | $value | Значение для завершения обработки |
Значение возврата
| mixed | Обработанное значение |
Исключения
| InvalidTypeException | если тип значения неверен |
| InvalidConfigurationException | если значение является недопустимой конфигурацией |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Config/Definition/NodeInterface.html