Spec-Zone.ru › Symfony 3.4

BaseNode

class BaseNode implements NodeInterface

Базовый класс узла.

Методы

__construct(string $name, NodeInterface $parent = null)
setAttribute($key, $value)
getAttribute($key, $default = null)
hasAttribute($key)
getAttributes()
setAttributes(array $attributes)
removeAttribute($key)
setInfo(string $info)

Устанавливает сообщение информации.

string getInfo()

Возвращает сообщение информации.

setExample(string|array $example)

Устанавливает пример конфигурации для этого узла.

string|array getExample()

Возвращает пример конфигурации для этого узла.

addEquivalentValue(mixed $originalValue, mixed $equivalentValue)

Добавляет эквивалентное значение.

setRequired(bool $boolean)

Устанавливает этот узел как обязательный.

setDeprecated(string|null $message)

Устанавливает этот узел как устаревший.

setAllowOverwrite(bool $allow)

Устанавливает, может ли этот узел быть перезаписан.

setNormalizationClosures(array $closures)

Устанавливает замыкания, используемые для нормализации.

setFinalValidationClosures(array $closures)

Устанавливает замыкания, используемые для окончательной валидации.

bool isRequired()

Проверяет, является ли этот узел обязательным.

bool isDeprecated()

Проверяет, является ли этот узел устаревшим.

string getDeprecationMessage(string $node, string $path)

Возвращает сообщение об устаревании.

string getName()

Возвращает имя этого узла.

string getPath()

Возвращает путь этого узла.

mixed merge(mixed $leftSide, mixed $rightSide)

Объединяет два значения вместе.

mixed normalize(mixed $value)

Нормализует значение, применяя все замыкания нормализации.

NodeInterface|null getParent()

Возвращает родительский узел для этого узла.

mixed finalize(mixed $value)

Окончательно обрабатывает значение, применяя все замыкания окончательной обработки.

Подробности

__construct(string $name, NodeInterface $parent = null)

Параметры

string $name Имя узла
NodeInterface $parent Родительский узел

Исключения

InvalidArgumentException если имя содержит точку

setAttribute($key, $value)

Параметры

$key
$value

getAttribute($key, $default = null)

Параметры

$key
$default

hasAttribute($key)

Параметры

$key

getAttributes()

setAttributes(array $attributes)

Параметры

array $attributes

removeAttribute($key)

Параметры

$key

setInfo(string $info)

Устанавливает сообщение информации.

Параметры

string $info

string getInfo()

Возвращает сообщение информации.

Значение возврата

string Текст информации

setExample(string|array $example)

Устанавливает пример конфигурации для этого узла.

Параметры

string|array $example

string|array getExample()

Возвращает пример конфигурации для этого узла.

Значение возврата

string|array Пример

addEquivalentValue(mixed $originalValue, mixed $equivalentValue)

Добавляет эквивалентное значение.

Параметры

mixed $originalValue
mixed $equivalentValue

setRequired(bool $boolean)

Устанавливает этот узел как обязательный.

Параметры

bool $boolean Обязательный узел

setDeprecated(string|null $message)

Устанавливает этот узел как устаревший.

Вы можете использовать плейсхолдеры %node% и %path%, чтобы соответственно отобразить имя узла и его полный путь.

Параметры

string|null $message Сообщение об устаревании

setAllowOverwrite(bool $allow)

Устанавливает, можно ли перезаписывать этот узел.

Параметры

bool $allow

setNormalizationClosures(array $closures)

Устанавливает замыкания, используемые для нормализации.

Параметры

array $closures Массив замыканий, используемых для нормализации

setFinalValidationClosures(array $closures)

Устанавливает замыкания, используемые для окончательной проверки.

Параметры

array $closures Массив замыканий, используемых для окончательной проверки

bool isRequired()

Проверяет, является ли этот узел обязательным.

Значение возврата

bool Если узел обязателен

bool isDeprecated()

Проверяет, является ли этот узел устаревшим.

Значение возврата

bool

string getDeprecationMessage(string $node, string $path)

Возвращает сообщение об устаревании.

Параметры

string $node имя узла конфигурации
string $path путь к узлу

Значение возврата

string

string getName()

Возвращает имя этого узла.

Значение возврата

string Имя узла

string getPath()

Возвращает путь к этому узлу.

Значение возврата

string Путь к узлу

final mixed merge(mixed $leftSide, mixed $rightSide)

Объединяет два значения.

Параметры

mixed $leftSide
mixed $rightSide

Значение возврата

mixed Объединенные значения

Исключения

ForbiddenOverwriteException

final mixed normalize(mixed $value)

Нормализует значение, применяя все замыкания нормализации.

Параметры

mixed $value Значение для нормализации

Значение возврата

mixed Нормализованное значение

NodeInterface|null getParent()

Возвращает родительский узел для этого узла.

Значение возврата

NodeInterface|null

final mixed finalize(mixed $value)

Окончательно обрабатывает значение, применяя все замыкания окончательной обработки.

Параметры

mixed $value Значение для окончательной обработки

Значение возврата

mixed Обработанное значение

Исключения

Исключение
Исключение некорректной конфигурации

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Config/Definition/BaseNode.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API