NumericNode

__construct(string|null $name, NodeInterface $parent = null, $min = null, $max = null, string $pathSeparator = BaseNode::DEFAULT_PATH_SEPARATOR)

Параметры

string|null	$name
NodeInterface	$parent
	$min
	$max
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)

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

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

Параметры

mixed

$value

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

bool