VariableNode

__construct(string|null $name, NodeInterface $parent = null, string $pathSeparator = self::DEFAULT_PATH_SEPARATOR)

Параметры

string|null	$name
NodeInterface	$parent
string	$pathSeparator

Исключения

InvalidArgumentException

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

static void setPlaceholder(string $placeholder, array $values)

Зарегистрировать возможные (фиктивные) значения для динамического значения placeholder.

Соответствующие значения конфигурации будут обработаны с предоставленным значением по одному. После успешной обработки предоставленного значения значение конфигурации возвращается как есть, сохраняя placeholder.

Параметры

string	$placeholder
array	$values

Возвращаемое значение

void

static void setPlaceholderUniquePrefix(string $prefix)

Устанавливает общий префикс для динамических значений placeholder.

Соответствующие значения конфигурации будут пропущены и возвращены как есть, сохраняя placeholder. Точное совпадение, предоставленное {см. setPlaceholder()}, может иметь приоритет.

Параметры

string

$prefix

Возвращаемое значение

void

static void resetPlaceholders()

Сбросить все текущие доступные placeholder.

Возвращаемое значение

void

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)

Устанавливает сообщение info.

Параметры

string

$info

string getInfo()

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

Возвращаемое значение

string

Текст сообщения info

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)

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

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

Параметры

string|null

$message

Сообщение об устаревании

setAllowOverwrite(bool $allow)

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

Параметры

bool

$allow

setNormalizationClosures(array $closures)

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

Параметры

array

$closures

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

setFinalValidationClosures(array $closures)

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

Параметры

array

$closures

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

bool isRequired()

Возвращает true, когда узел обязателен.

Возвращаемое значение

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	если путь конфигурации не может быть перезаписан
InvalidTypeException	если тип значения неверный

final mixed normalize(mixed $value)

Нормализует значение.

Параметры

mixed

$value

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

Возвращаемое значение

mixed

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

Исключения

InvalidTypeException

если тип значения неверный

protected $value preNormalize($value)

Нормализует значение перед применением других нормализаций.

Параметры

$value

Возвращаемое значение

$value

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

NodeInterface|null getParent()

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

Возвращаемое значение

NodeInterface|null

final mixed finalize(mixed $value)

Завершает значение.

Параметры

mixed

$value

Значение для завершения

Возвращаемое значение

mixed

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

Исключения

InvalidTypeException	если тип значения неверный
InvalidConfigurationException	если значение не является допустимой конфигурацией

protected validateType(mixed $value)

Проверяет тип узла.

Параметры

mixed

$value

Значение для проверки

Исключения

InvalidTypeException

при некорректном значении

protected mixed normalizeValue(mixed $value)

Нормализует значение.

Параметры

mixed

$value

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

Возвращаемое значение

mixed

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

protected mixed mergeValues(mixed $leftSide, mixed $rightSide)

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

Параметры

mixed	$leftSide
mixed	$rightSide

Возвращаемое значение

mixed

Объединённое значение

protected mixed finalizeValue(mixed $value)

Завершает обработку значения.

Параметры

mixed

$value

Значение для завершения обработки

Возвращаемое значение

mixed

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

protected bool allowPlaceholders()

Проверяет, разрешены ли значения-заполнители для этого узла.

Возвращаемое значение

bool

protected bool isHandlingPlaceholder()

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

Возвращаемое значение

bool

protected array getValidPlaceholderTypes()

Возвращает допустимые динамические типы для данного узла.

Возвращаемое значение

array

setDefaultValue($value)

Параметры

$value

bool hasDefaultValue()

Возвращает true, если у узла есть значение по умолчанию.

Возвращаемое значение

bool	Если у узла есть значение по умолчанию

mixed getDefaultValue()

Возвращает значение по умолчанию узла.

Возвращаемое значение

mixed

Значение по умолчанию

Исключения

RuntimeException

если у узла нет значения по умолчанию

setAllowEmptyValue(bool $boolean)

Устанавливает, разрешено ли для этого узла пустое значение.

Параметры

bool

$boolean

True, если этот объект может принимать пустые значения

setName(string $name)

Устанавливает имя узла.

Параметры

string

$name

Имя узла

protected bool isValueEmpty(mixed $value)

Определяет, считается ли данное значение пустым.

По умолчанию используется функция PHP empty(). Этот метод можно переопределить в подтипах для лучшего соответствия пониманию пустых данных.

Параметры

mixed

$value

Возвращаемое значение

bool