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

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

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

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

addChild(NodeInterface $node)

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

Параметры

NodeInterface

$node

Исключения

Exception

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

Прототип