IdenticalTo
class IdenticalTo 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::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.
Возвращаемое значение
| string|array | Одно или несколько значений констант |
array __sleep()
Оптимизирует сериализованное значение, чтобы минимизировать объём памяти.
Возвращаемое значение
| array | Свойства для сериализации |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Validator/Constraints/IdenticalTo.html