Spec-Zone.ru › Symfony 3.4

FloatNode

class FloatNode extends NumericNode

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

Методы

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

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

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

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

from BaseNode
setDefaultValue($value)

{@inheritdoc}

from VariableNode
bool hasDefaultValue()

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

from VariableNode
mixed getDefaultValue()

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

from VariableNode
setAllowEmptyValue(bool $boolean)

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

from VariableNode
setName(string $name)

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

from VariableNode

Подробности

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

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

Параметры

string $name Имя узла
NodeInterface $parent Родительский узел
$min
$max

Исключения

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.4/Symfony/Component/Config/Definition/FloatNode.html

Spec-Zone.ru

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