PrototypedArrayNode

__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

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

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

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

Исключения

Исключение
Исключение некорректной конфигурации

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

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

addChild(NodeInterface $node)

Отключить добавление конкретных потомков для узлов-прототипов.

Параметры

NodeInterface

$node

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

Исключения

Исключение

setMinNumberOfElements(int $number)

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

Параметры

int

$number

setKeyAttribute(string $attribute, bool $remove = true)

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

Это полезно, когда у вас есть индексированный массив, который должен быть ассоциативным массивом. Вы можете выбрать элемент внутри массива, который будет ключом конкретного элемента. Например, если "id" — это "ключ", то:

array(
    array('id' => 'my_name', 'foo' => 'bar'),
);

становится

 array(
     'my_name' => array('foo' => 'bar'),
 );

Если вы хотите, чтобы "'id' => 'my_name'" всё ещё присутствовал в результирующем массиве, то вы можете установить второе значение аргумента этого метода в false.

Параметры

string	$attribute	Имя атрибута, значение которого будет использоваться в качестве ключа
bool	$remove	Удалять ли ключ

string getKeyAttribute()

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

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

string

Имя атрибута

setDefaultValue(string $value)

Устанавливает значение по умолчанию для этого узла.

Параметры

string

$value

Исключения

InvalidArgumentException

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

setAddChildrenIfNoneSet(int|string|array|null $children = array('defaults'))

Добавляет дочерние элементы по умолчанию, если они не установлены.

Параметры

int|string|array|null

$children

Количество дочерних элементов|Имя дочернего элемента|Имена дочерних элементов, которые нужно добавить

setPrototype(PrototypeNodeInterface $node)

Устанавливает прототип узла.

Параметры

PrototypeNodeInterface

$node

PrototypeNodeInterface getPrototype()

Возвращает прототип.

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

PrototypeNodeInterface

Прототип