ArrayNode

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

Сбрасывает все текущие доступные 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)

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

Параметры

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)

Нормализует ключи между различными форматами конфигурации.

В частности, в YAML вы чаще всего встречаете foo_bar, а в XML — foo-bar. После выполнения этого метода все ключи будут нормализованы до foo_bar.

Если у вас смешанный ключ, например, foo-bar_moo, он не будет изменен. Ключ также не будет изменен, если целевой ключ уже существует.

Параметры

$value

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

$value

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

NodeInterface|null getParent()

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

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

NodeInterface|null

final mixed finalize(mixed $value)

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

Параметры

mixed

$value

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

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

mixed

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

Исключения

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

protected validateType(mixed $value)

Проверяет тип значения.

Параметры

смешанный тип

$value

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

Исключения

InvalidTypeException

protected смешанный тип normalizeValue(смешанный тип $value)

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

Параметры

смешанный тип

$value

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

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

смешанный тип

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

Исключения

InvalidConfigurationException

protected смешанный тип mergeValues(смешанный тип $leftSide, смешанный тип $rightSide)

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

Параметры

смешанный тип	$leftSide
смешанный тип	$rightSide

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

смешанный тип

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

Исключения

InvalidConfigurationException
RuntimeException

protected смешанный тип finalizeValue(смешанный тип $value)

Окончательно обрабатывает значение этого узла.

Параметры

смешанный тип

$value

Значение для окончательной обработки

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

смешанный тип

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

Исключения

UnsetKeyException
InvalidConfigurationException	если у узла недостаточно дочерних элементов

protected bool allowPlaceholders()

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

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

bool

protected bool isHandlingPlaceholder()

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

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

bool

protected array getValidPlaceholderTypes()

Получает разрешенные динамические типы для этого узла.

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

array

setNormalizeKeys($normalizeKeys)

Параметры

$normalizeKeys

array getChildren()

Возвращает дочерние элементы этого узла.

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

array

Дочерние элементы

setXmlRemappings(array $remappings)

Устанавливает XML-преобразования, которые должны быть выполнены.

Параметры

array

$remappings

Массив вида array(array(string, string))

array getXmlRemappings()

Получает XML-преобразования, которые должны быть выполнены.

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

array

$remappings массив вида array(array(string, string))

setAddIfNotSet(bool $boolean)

Устанавливает, нужно ли добавлять значения по умолчанию для этого массива, если они не были определены ни в одном из файлов конфигурации.

Параметры

bool

$boolean

setAllowFalse(bool $allow)

Устанавливает, разрешено ли значение false, указывающее, что массив должен быть удален.

Параметры

bool

$allow

setAllowNewKeys(bool $allow)

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

Параметры

bool

$allow

setPerformDeepMerging(bool $boolean)

Устанавливает, нужно ли выполнять глубокое объединение.

Параметры

bool

$boolean

setIgnoreExtraKeys(bool $boolean, bool $remove = true)

Указывает, нужно ли просто игнорировать дополнительные ключи без исключения.

Параметры

bool	$boolean	Разрешить дополнительные ключи
bool	$remove	Удалить дополнительные ключи

setName(string $name)

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

Параметры

string

$name

Имя узла

bool hasDefaultValue()

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

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

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

mixed getDefaultValue()

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

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

смешанный тип

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

Исключения

RuntimeException

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

addChild(NodeInterface $node)

Добавляет дочерний узел.

Параметры

NodeInterface

$node

Исключения

InvalidArgumentException	когда у дочернего узла нет имени
InvalidArgumentException	когда имя дочернего узла не уникально

protected array remapXml(array $value)

Переименовывает несколько отдельных значений в одно множественное значение.

Параметры

array

$value

Исходные значения

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

array

Преобразованные значения