ArrayNode

__construct(string $name, NodeInterface $parent = null)

Параметры

string	$name	Имя узла
NodeInterface	$parent	Родительский узел

Исключения

InvalidArgumentException

если имя содержит точку

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

Проверяет, является ли этот узел обязательным.

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

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

final mixed normalize(mixed $value)

Нормализует значение, применяя все замыкания нормализации.

Параметры

mixed

$value

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

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

mixed

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

NodeInterface|null getParent()

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

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

NodeInterface|null

final mixed finalize(mixed $value)

Завершает значение, применяя все замыкания завершения.

Параметры

mixed

$value

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

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

mixed

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

Исключения

Exception
InvalidConfigurationException

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

Проверяет, имеет ли узел значение по умолчанию.

Результат

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

mixed getDefaultValue()

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

Результат

mixed

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

Исключения

RuntimeException

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

addChild(NodeInterface $node)

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

Параметры

NodeInterface

$node

Исключения

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