BooleanNode

__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