AbstractComparison
class AbstractComparison extends Constraint
Используется для сравнения значений.
Постоянные значения
| DEFAULT_GROUP | Имя группы, присваиваемой всем ограничениям без явного указания группы. |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам. |
Свойства
| mixed | $payload | Данные, специфичные для домена, прикреплённые к ограничению. | из Constraint |
| array | $groups | Группы, к которым относится ограничение | из Constraint |
| $message | |||
| $value |
Методы
| static string | getErrorName(string $errorCode) Возвращает имя заданного кода ошибки. | из Constraint |
| __construct(mixed $options = null) Инициализирует ограничение с опциями. | ||
| __set(string $option, mixed $value) Устанавливает значение лениво инициализированной опции. | из Constraint | |
| mixed | __get(string $option) Возвращает значение лениво инициализированной опции. | из Constraint |
| addImplicitGroupName(string $group) Добавляет заданную группу, если это ограничение в группе «По умолчанию». | из Constraint | |
| string | getDefaultOption() Возвращает имя опции по умолчанию. | |
| array | getRequiredOptions() Возвращает имена обязательных опций. | из Constraint |
| string | validatedBy() Возвращает имя класса, который валидирует это ограничение. | из Constraint |
| string|array | getTargets() Возвращает, можно ли применить ограничение к классам, свойствам или обоим. | из Constraint |
| array | __sleep() Оптимизирует сериализованное значение для минимизации объёма занимаемой памяти. | из Constraint |
Подробности
static string getErrorName(string $errorCode)
Возвращает имя заданного кода ошибки.
Параметры
| string | $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/3.2/Symfony/Component/Validator/Constraints/AbstractComparison.html