EnumNode

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

Параметры

string|null	$name
NodeInterface	$parent
array	$values
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

getValues()