Spec-Zone.ru › Symfony 2.7

EqualTo

class EqualTo extends AbstractComparison

Постоянные

DEFAULT_GROUP

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

CLASS_CONSTRAINT

Отмечает ограничение, которое можно применить к классам

PROPERTY_CONSTRAINT

Отмечает ограничение, которое можно применить к свойствам

Свойства

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

Методы

static string getErrorName(int $errorCode)

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

из Constraint
__construct(mixed $options = null)

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

из AbstractComparison
__set(string $option, mixed $value)

Устанавливает значение параметра, инициализируемого по мере необходимости.

из Constraint
mixed __get(string $option)

Возвращает значение параметра, инициализируемого по мере необходимости.

из Constraint
addImplicitGroupName(string $group)

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

из Constraint
string getDefaultOption()

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

из AbstractComparison
array getRequiredOptions()

Возвращает имя обязательных параметров

из Constraint
string validatedBy()

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

из Constraint
string|array getTargets()

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

из Constraint
array __sleep()

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

из 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

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/2.7/Symfony/Component/Validator/Constraints/EqualTo.html

Spec-Zone.ru

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