PrototypedArrayNode

class PrototypedArrayNode extends ArrayNode

Представляет прототипизированный узел Array в дереве конфигурации.

Методы

	__construct(string $name, NodeInterface $parent = null) Конструктор.	from BaseNode
	setAttribute($key, $value)	from BaseNode
	getAttribute($key, $default = null)	from BaseNode
	hasAttribute($key)	from BaseNode
	getAttributes()	from BaseNode
	setAttributes(array $attributes)	from BaseNode
	removeAttribute($key)	from BaseNode
	setInfo(string $info) Устанавливает сообщение info.	from BaseNode
string	getInfo() Возвращает сообщение info.	from BaseNode
	setExample(string\|array $example) Устанавливает пример конфигурации для данного узла.	from BaseNode
string\|array	getExample() Возвращает пример конфигурации для данного узла.	from BaseNode
	addEquivalentValue(mixed $originalValue, mixed $equivalentValue) Добавляет эквивалентное значение.	from BaseNode
	setRequired(bool $boolean) Устанавливает обязательность данного узла.	from BaseNode
	setAllowOverwrite(bool $allow) Устанавливает, может ли этот узел быть перезаписан.	from BaseNode
	setNormalizationClosures(array $closures) Устанавливает замыкания, используемые для нормализации.	from BaseNode
	setFinalValidationClosures(array $closures) Устанавливает замыкания, используемые для окончательной валидации.	from BaseNode
bool	isRequired() Проверяет, является ли этот узел обязательным.	from BaseNode
string	getName() Возвращает имя этого узла.	from BaseNode
string	getPath() Возвращает путь этого узла.	from BaseNode
mixed	merge(mixed $leftSide, mixed $rightSide) Объединяет два значения вместе.	from BaseNode
mixed	normalize(mixed $value) Нормализует значение, применяя все замыкания нормализации.	from BaseNode
NodeInterface\|null	getParent() Возвращает родительский узел для данного узла.	from BaseNode
mixed	finalize(mixed $value) Окончательно обрабатывает значение, применяя все замыкания окончательной обработки.	from BaseNode
	setNormalizeKeys($normalizeKeys)	from ArrayNode
array	getChildren() Возвращает дочерние узлы этого узла.	from ArrayNode
	setXmlRemappings(array $remappings) Устанавливает xml-преобразования, которые должны быть выполнены.	from ArrayNode
array	getXmlRemappings() Получает xml-преобразования, которые должны быть выполнены.	from ArrayNode
	setAddIfNotSet(bool $boolean) Устанавливает, добавлять ли значения по умолчанию для этого массива, если они не определены ни в одном из файлов конфигурации.	from ArrayNode
	setAllowFalse(bool $allow) Устанавливает, разрешено ли значение false, указывающее на то, что массив должен быть удален.	from ArrayNode
	setAllowNewKeys(bool $allow) Устанавливает, могут ли быть определены новые ключи в последующих конфигурациях.	from ArrayNode
	setPerformDeepMerging(bool $boolean) Устанавливает, должно ли выполняться глубокое объединение.	from ArrayNode
	setIgnoreExtraKeys(bool $boolean, bool $remove = true) Указывает, должны ли игнорироваться дополнительные ключи без исключения.	from ArrayNode
	setName(string $name) Устанавливает имя узла.	from ArrayNode
bool	hasDefaultValue() Проверяет, имеет ли узел значение по умолчанию.
mixed	getDefaultValue() Возвращает значение по умолчанию.
	addChild(NodeInterface $node) Отключить добавление конкретных дочерних узлов для прототипизированных узлов.
	setMinNumberOfElements(int $number) Устанавливает минимальное количество элементов, которое должен содержать узел, основанный на прототипе. По умолчанию это ноль, что означает отсутствие элементов.
	setKeyAttribute(string $attribute, bool $remove = true) Устанавливает атрибут, значение которого будет использоваться в качестве ключа.
string	getKeyAttribute() Возвращает имя атрибута, значение которого должно использоваться в качестве ключа.
	setDefaultValue(string $value) Устанавливает значение по умолчанию для этого узла.
	setAddChildrenIfNoneSet(int\|string\|array\|null $children = array('defaults')) Добавляет дочерние узлы по умолчанию, если они не заданы.
	setPrototype(PrototypeNodeInterface $node) Устанавливает прототип узла.
PrototypeNodeInterface	getPrototype() Возвращает прототип.

Подробности

__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	Удалить ли ключ