Spec-Zone.ru › Symfony 3.0

VariableNode

class VariableNode extends BaseNode implements PrototypeNodeInterface

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

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

Методы

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

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

from BaseNode
string getInfo()

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

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
mixed finalize(mixed $value)

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

from 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/3.0/Symfony/Component/Config/Definition/VariableNode.html

Spec-Zone.ru

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