Spec-Zone.ru › Symfony 3.0

BaseNode

class BaseNode implements NodeInterface

Базовый класс узла.

Методы

__construct(string $name, NodeInterface $parent = null)

Конструктор.

setAttribute($key, $value)
getAttribute($key, $default = null)
hasAttribute($key)
getAttributes()
setAttributes(array $attributes)
removeAttribute($key)
setInfo(string $info)

Устанавливает сообщение info.

string getInfo()

Возвращает сообщение info.

setExample(string|array $example)

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

string|array getExample()

Возвращает пример конфигурации для этого узла.

addEquivalentValue(mixed $originalValue, mixed $equivalentValue)

Добавляет эквивалентное значение.

setRequired(bool $boolean)

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

setAllowOverwrite(bool $allow)

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

setNormalizationClosures(array $closures)

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

setFinalValidationClosures(array $closures)

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

bool isRequired()

Проверяет, является ли этот узел обязательным.

string getName()

Возвращает имя этого узла.

string getPath()

Возвращает путь этого узла.

mixed merge(mixed $leftSide, mixed $rightSide)

Объединяет два значения вместе.

mixed normalize(mixed $value)

Нормализует значение, применяя все замыкания нормализации.

NodeInterface|null getParent()

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

mixed finalize(mixed $value)

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

Детали

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

Устанавливает сообщение info.

Параметры

string $info

string getInfo()

Возвращает сообщение info.

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

string Текст сообщения info

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

Исключения

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

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

Spec-Zone.ru

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