ArrayNodeDefinition

__construct(string|null $name, NodeParentInterface $parent = null)

Параметры

string|null	$name
NodeParentInterface	$parent

$this setParent(NodeParentInterface $parent)

Устанавливает родительский узел.

Параметры

NodeParentInterface

$parent

Возвращаемое значение

$this

$this info(string $info)

Устанавливает сообщение с информацией.

Параметры

string

$info

Текст информации

Возвращаемое значение

$this

$this example(string|array $example)

Устанавливает пример конфигурации.

Параметры

string|array

$example

Возвращаемое значение

$this

$this attribute(string $key, mixed $value)

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

Параметры

string	$key
mixed	$value

Возвращаемое значение

$this

NodeParentInterface|NodeBuilder|NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition|null end()

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

Возвращаемое значение

NodeParentInterface|NodeBuilder|NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition|null

Построитель родительского узла

NodeInterface getNode(bool $forceRootNode = false)

Создает узел.

Параметры

bool

$forceRootNode

Принудительно сделать этот узел корневым узлом

Возвращаемое значение

NodeInterface

$this defaultValue(mixed $value)

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

Параметры

mixed

$value

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

Возвращаемое значение

$this

$this isRequired()

Устанавливает узел как обязательный.

Возвращаемое значение

$this

$this setDeprecated(string $message = 'The child node "%node%" at path "%path%" is deprecated.')

Устанавливает узел как устаревший.

Вы можете использовать %node% и %path% в качестве заполнитель для отображения имени узла и его полного пути соответственно.

Параметры

string

$message

Сообщение об устаревании

Возвращаемое значение

$this

$this treatNullLike(mixed $value)

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

Параметры

mixed

$value

Возвращаемое значение

$this

$this treatTrueLike(mixed $value)

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

Параметры

mixed

$value

Возвращаемое значение

$this

$this treatFalseLike(mixed $value)

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

Параметры

mixed

$value

Возвращаемое значение

$this

$this defaultNull()

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

Возвращаемое значение

$this

$this defaultTrue()

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

Возвращаемое значение

$this

$this defaultFalse()

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

Возвращаемое значение

$this

ExprBuilder beforeNormalization()

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

Возвращаемое значение

ExprBuilder

$this cannotBeEmpty()

Запрещает значение узла быть пустым.

Возвращаемое значение

$this

ExprBuilder validate()

Устанавливает выражение для проверки.

Выражение получает значение узла и должно вернуть его. Оно может его изменить. Исключение должно быть выброшено, когда узел недействителен.

Возвращаемое значение

ExprBuilder

$this cannotBeOverwritten(bool $deny = true)

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

Параметры

bool

$deny

Запрещено ли перезаписывание или нет

Возвращаемое значение

$this

protected ValidationBuilder validation()

Получает построитель для правил проверки.

Возвращаемое значение

ValidationBuilder

protected MergeBuilder merge()

Получает построитель для правил слияния.

Возвращаемое значение

MergeBuilder

protected NormalizationBuilder normalization()

Получает построитель для правил нормализации.

Возвращаемое значение

NormalizationBuilder

protected NodeInterface createNode()

Инициализирует и настраивает узел в соответствии с этим определением.

Возвращаемое значение

NodeInterface

$node Экземпляр узла

Исключения

InvalidDefinitionException

Когда определение некорректно

$this setPathSeparator(string $separator)

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

Параметры

string

$separator

Возвращаемое значение

$this

setBuilder(NodeBuilder $builder)

Устанавливает пользовательского построителя дочерних элементов.

Параметры

NodeBuilder

$builder

NodeBuilder children()

Возвращает билдер для добавления дочерних узлов.

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

NodeBuilder

NodeDefinition prototype(string $type)

Устанавливает шаблон для дочерних узлов.

Параметры

string

$type

Тип узла

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

NodeDefinition

VariableNodeDefinition variablePrototype()

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

VariableNodeDefinition

ScalarNodeDefinition scalarPrototype()

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

ScalarNodeDefinition

BooleanNodeDefinition booleanPrototype()

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

BooleanNodeDefinition

IntegerNodeDefinition integerPrototype()

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

IntegerNodeDefinition

FloatNodeDefinition floatPrototype()

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

FloatNodeDefinition

ArrayNodeDefinition arrayPrototype()

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

ArrayNodeDefinition

EnumNodeDefinition enumPrototype()

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

EnumNodeDefinition

$this addDefaultsIfNotSet()

Добавляет значение по умолчанию, если узел не задан в конфигурации.

Этот метод применим только к конкретным узлам (не к шаблонам узлов). Если этот метод был вызван, и узел не задан на стадии финализации, его значение по умолчанию будет получено из значений по умолчанию его дочерних узлов.

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

$this

$this addDefaultChildrenIfNoneSet(int|string|array|null $children = null)

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

Этот метод применим только к шаблонам узлов.

Параметры

int|string|array|null

$children

Количество дочерних узлов/Имя дочернего узла/Имена дочерних узлов для добавления

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

$this

$this requiresAtLeastOneElement()

Требует, чтобы узел имел как минимум один элемент.

Этот метод применим только к шаблонам узлов.

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

$this

$this disallowNewKeysInSubsequentConfigs()

Запрещает добавление новых ключей в последующих конфигурациях.

Если используется, все ключи должны быть определены в одном файле конфигурации.

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

$this

$this fixXmlConfig(string $singular, string $plural = null)

Устанавливает правило нормализации для конфигураций XML.

Параметры

string	$singular	Ключ для переназначения
string	$plural	Множественное число ключа для нестандартных множественных чисел

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

$this

$this useAttributeAsKey(string $name, bool $removeKeyItem = true)

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

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

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

становится

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

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

Этот метод применим только к шаблонам узлов.

Параметры

string	$name	Имя ключа
bool	$removeKeyItem	Удалить элемент ключа или нет

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

$this

$this canBeUnset(bool $allow = true)

Устанавливает, может ли узел быть удалён.

Параметры

bool

$allow

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

$this

$this canBeEnabled()

Добавляет булеву переменную "enabled" для активации текущего раздела.

По умолчанию раздел отключен. Если любая конфигурация указана, узел автоматически активируется:

enableableArrayNode: {enabled: true, ...} # Конфигурация включена & значения по умолчанию переопределяются enableableArrayNode: ~ # Конфигурация включена & используются значения по умолчанию enableableArrayNode: true # Конфигурация включена & используются значения по умолчанию enableableArrayNode: {other: value, ...} # Конфигурация включена & значения по умолчанию переопределяются enableableArrayNode: {enabled: false, ...} # Конфигурация выключена enableableArrayNode: false # Конфигурация выключена

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

$this

$this canBeDisabled()

Добавляет булеву переменную "enabled" для активации текущего раздела.

По умолчанию раздел включен.

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

$this

$this performNoDeepMerging()

Отключает глубокое слияние узла.

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

$this

$this ignoreExtraKeys(bool $remove = true)

Разрешает указывать дополнительные ключи конфигурации в массиве без выброса исключения.

Эти значения конфигурации просто игнорируются и удаляются из результирующего массива. Это следует использовать только в особых случаях, когда вы хотите передать весь массив конфигурации через специальное дерево, которое обрабатывает только часть массива.

Параметры

bool

$remove

Удалить дополнительные ключи

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

$this

$this normalizeKeys(bool $bool)

Устанавливает нормализацию ключей.

Параметры

bool

$bool

Включить нормализацию ключей

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

$this

$this append(NodeDefinition $node)

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

Использование:

$node = $parentNode
    ->children()
        ->scalarNode('foo')->end()
        ->scalarNode('baz')->end()
        ->append($this->getBarNodeDefinition())
    ->end()
;

Параметры

NodeDefinition

$node

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

$this

protected NodeBuilder getNodeBuilder()

Возвращает билдер узла, который используется для добавления дочерних элементов и шаблона.

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

NodeBuilder

Билдер узла

protected validateConcreteNode(ArrayNode $node)

Проверка конфигурации конкретного узла.

Параметры

ArrayNode

$node

Исключения

InvalidDefinitionException

protected validatePrototypeNode(PrototypedArrayNode $node)

Проверка конфигурации узла прототипа.

Параметры

PrototypedArrayNode

$node

Исключения

InvalidDefinitionException

NodeDefinition[] getChildNodeDefinitions()

Возвращаемое значение

NodeDefinition[]