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 | Нормализованное значение |
mixed merge(mixed $leftSide, mixed $rightSide)
Объединяет два значения вместе.
Параметры
| mixed | $leftSide | |
| mixed | $rightSide |
Значение возврата
| mixed | Объединенные значения |
mixed finalize(mixed $value)
Завершает значение.
Параметры
| mixed | $value | Значение для завершения |
Значение возврата
| mixed | Завершенное значение |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Config/Definition/NodeInterface.html