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)

Устанавливает сообщение info.

Параметры

string

$info

string getInfo()

Возвращает сообщение info.

Значение результата

string

Текст сообщения info

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

Обязательный узел

setAllowOverwrite(bool $allow)

Устанавливает, можно ли перезаписать этот узел.

Параметры

bool

$allow

setNormalizationClosures(array $closures)

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

Параметры

array

$closures

Массив замыканий, используемых для нормализации

setFinalValidationClosures(array $closures)

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

Параметры

array

$closures

Массив замыканий, используемых для окончательной проверки

bool isRequired()

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

Значение результата

bool	Если узел обязательный

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	при отсутствии уникальности имени дочернего узла