BooleanNode
class BooleanNode extends ScalarNode
Этот узел представляет булево значение в дереве конфигурации.
Методы
| __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} | из VariableNode | |
| bool | hasDefaultValue() Возвращает true, если у узла есть значение по умолчанию. | из VariableNode |
| mixed | getDefaultValue() Возвращает значение по умолчанию узла. | из VariableNode |
| setAllowEmptyValue(bool $boolean) Устанавливает, разрешено ли этому узлу иметь пустое значение. | из VariableNode | |
| setName(string $name) Устанавливает имя узла. | из VariableNode |
Подробности
__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 | Обработанное значение |
Исключения
| Exception | |
| InvalidConfigurationException |
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/BooleanNode.html
