Spec-Zone.ru › Symfony 2.7

VariableNode

class VariableNode extends BaseNode implements PrototypeNodeInterface

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

Этот узел предназначен для значений произвольного типа. В качестве значения принимается любой тип PHP.

Методы

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

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

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

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

из BaseNode
string getInfo()

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

из BaseNode
setExample(string|array $example)

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

из BaseNode
string|array getExample()

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

из BaseNode
addEquivalentValue(mixed $originalValue, mixed $equivalentValue)

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

из BaseNode
setRequired(bool $boolean)

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

из BaseNode
setAllowOverwrite(bool $allow)

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

из BaseNode
setNormalizationClosures(array $closures)

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

из BaseNode
setFinalValidationClosures(array $closures)

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

из BaseNode
bool isRequired()

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

из BaseNode
string getName()

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

из BaseNode
string getPath()

Получает путь к этому узлу.

из BaseNode
mixed merge(mixed $leftSide, mixed $rightSide)

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

из BaseNode
mixed normalize(mixed $value)

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

из BaseNode
NodeInterface|null getParent()

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

из BaseNode
mixed finalize(mixed $value)

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

из BaseNode
setDefaultValue($value)

{@inheritdoc}

bool hasDefaultValue()

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

mixed getDefaultValue()

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

setAllowEmptyValue(bool $boolean)

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

setName(string $name)

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

Подробности

__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 Обработанное значение

Исключения

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

setDefaultValue($value)

{@inheritdoc}

Параметры

$value

bool hasDefaultValue()

Возвращает true, когда у узла есть значение по умолчанию.

Значение результата

bool Если у узла есть значение по умолчанию

mixed getDefaultValue()

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

Значение результата

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

Исключения

RuntimeException если у узла нет значения по умолчанию

setAllowEmptyValue(bool $boolean)

Устанавливает, разрешено ли пустое значение для этого узла.

Параметры

bool $boolean True, если эта сущность допускает пустые значения

setName(string $name)

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

Параметры

string $name Имя узла

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

Spec-Zone.ru

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