ScalarNode

__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)

Регистрирует возможные (фиктивные) значения для динамического значения заполнителя.

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

Параметры

string	$placeholder
array	$values

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

void

static void setPlaceholderUniquePrefix(string $prefix)

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

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

Параметры

string

$prefix

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

void

static void resetPlaceholders()

Сбрасывает все текущие доступные заполнители.

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

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)

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

Параметры

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()

Возвращает 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