Spec-Zone.ru › Symfony 3.0

ArrayNode

class ArrayNode extends BaseNode implements PrototypeNodeInterface

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

Методы

__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)

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

from BaseNode
string getInfo()

Возвращает сообщение об информации.

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
смешанный finalize(mixed $value)

Завершает значение, применяя все завершающие замыкания.

из BaseNode
setNormalizeKeys($normalizeKeys)
массив getChildren()

Возвращает дочерние узлы этого узла.

setXmlRemappings(array $remappings)

Устанавливает переназначения XML, которые должны быть выполнены.

массив getXmlRemappings()

Получает переназначения XML, которые должны быть выполнены.

setAddIfNotSet(bool $boolean)

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

setAllowFalse(bool $allow)

Устанавливает, разрешено ли значение false, указывающее, что массив должен быть удален.

setAllowNewKeys(bool $allow)

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

setPerformDeepMerging(bool $boolean)

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

setIgnoreExtraKeys(bool $boolean, bool $remove = true)

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

setName(string $name)

Устанавливает имя узла.

bool hasDefaultValue()

Проверяет, имеет ли узел значение по умолчанию.

смешанный getDefaultValue()

Возвращает значение по умолчанию.

addChild(NodeInterface $node)

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

Подробности

__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 Завершенное значение

Исключения

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

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Config/Definition/ArrayNode.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API