Spec-Zone.ru › Symfony 3.2

True deprecated

class True extends IsTrue

deprecated

since version 2.7, to be removed in 3.0. Use IsTrue instead.

Константы

DEFAULT_GROUP

Имя группы, задаваемой всем ограничениям без явного указания группы.

CLASS_CONSTRAINT

Помечает ограничение, которое может быть применено к классам.

PROPERTY_CONSTRAINT

Помечает ограничение, которое может быть применено к свойствам.

NOT_TRUE_ERROR

Свойства

mixed $payload Данные, специфичные для области, прикрепленные к ограничению. from Constraint
array $groups Группы, к которым относится ограничение from Constraint
$message from IsTrue

Методы

static string getErrorName(int $errorCode)

Возвращает имя данного кода ошибки.

from Constraint
__construct(mixed $options = null)

Инициализирует ограничение с опциями.

from Constraint
__set(string $option, mixed $value)

Устанавливает значение отложенно инициализированной опции.

from Constraint
mixed __get(string $option)

Возвращает значение отложенно инициализированной опции.

from Constraint
addImplicitGroupName(string $group)

Добавляет заданную группу, если это ограничение находится в группе по умолчанию.

from Constraint
string getDefaultOption()

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

from Constraint
array getRequiredOptions()

Возвращает имена требуемых опций.

from Constraint
string validatedBy()

Возвращает имя класса, который валидирует это ограничение.

from Constraint
string|array getTargets()

Возвращает, может ли ограничение быть применено к классам, свойствам или обоим.

from Constraint
array __sleep()

Оптимизирует сериализованное значение для минимизации места хранения.

from Constraint

Подробное описание

static string getErrorName(int $errorCode)

Возвращает имя данного кода ошибки.

Параметры

int $errorCode Код ошибки

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

string Имя кода ошибки

Исключения

InvalidArgumentException Если код ошибки не существует

__construct(mixed $options = null)

Инициализирует ограничение с опциями.

Вы должны передать ассоциативный массив. Ключи должны быть именами существующих свойств в этом классе. Значения должны быть значениями для этих свойств.

В качестве альтернативы можно переопределить метод getDefaultOption(), чтобы вернуть имя существующего свойства. Если не передан ассоциативный массив, устанавливается это свойство.

Вы можете принудительно установить определенные опции, переопределив getRequiredOptions(), чтобы вернуть имена этих опций. Если какая-либо опция не установлена здесь, выбрасывается исключение.

Параметры

mixed $options Опции (как ассоциативный массив) или значение для опции по умолчанию (любой другой тип)

Исключения

InvalidOptionsException При передаче имен несуществующих опций
MissingOptionsException При отсутствии каких-либо опций, возвращаемых getRequiredOptions()
ConstraintDefinitionException Если вы не передаете ассоциативный массив, а getDefaultOption() возвращает null

__set(string $option, mixed $value)

Устанавливает значение отложенно инициализированной опции.

Соответствующие свойства добавляются в объект при первом доступе. Следовательно, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя опции.

Параметры

string $option Имя опции
mixed $value Значение для установки

Исключения

InvalidOptionsException Если задано некорректное имя опции

mixed __get(string $option)

Возвращает значение отложенно инициализированной опции.

Соответствующие свойства добавляются в объект при первом доступе. Следовательно, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя опции.

Параметры

string $option Имя опции

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

mixed Значение опции

Исключения

InvalidOptionsException Если задано некорректное имя опции

addImplicitGroupName(string $group)

Добавляет заданную группу, если это ограничение находится в группе по умолчанию.

Параметры

string $group

string getDefaultOption()

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

Переопределите этот метод для определения опции по умолчанию.

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

string

См. также

__construct()

array getRequiredOptions()

Возвращает имена требуемых опций.

Переопределите этот метод, если хотите определить требуемые опции.

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

array

См. также

__construct()

string validatedBy()

Возвращает имя класса, который валидирует это ограничение.

По умолчанию это полное имя класса ограничения с добавленным "Validator". Можно переопределить этот метод, чтобы изменить это поведение.

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

string

string|array getTargets()

Возвращает, может ли ограничение быть применено к классам, свойствам или обоим.

Этот метод должен возвращать одно или несколько значений констант Constraint::CLASSCONSTRAINT и Constraint::PROPERTYCONSTRAINT.

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

string|array Одно или несколько значений констант

array __sleep()

Оптимизирует сериализованное значение для минимизации места хранения.

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

array Свойства для сериализации

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Validator/Constraints/True.html

Spec-Zone.ru

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