УникальныйСущность
класс УникальныйСущность расширяет Ограничение
Ограничение для валидатора Уникальной сущности.
Постоянные
| DEFAULT_GROUP | Имя группы, задаваемой всем ограничениям без явной группы. |
| CLASS_CONSTRAINT | Помечает ограничение, которое можно применить к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое можно применить к свойствам. |
Свойства
| смешанный | $payload | Данные, специфичные для области, прикрепленные к ограничению. | от Ограничение |
| массив | $groups | Группы, к которым относится ограничение | от Ограничение |
| $message | |||
| $service | |||
| $em | |||
| $repositoryMethod | |||
| $fields | |||
| $errorPath | |||
| $ignoreNull |
Методы
| статический строка | getErrorName(int $errorCode) Возвращает имя данного кода ошибки. | от Ограничение |
| __construct(смешанный $options = null) Инициализирует ограничение с параметрами. | от Ограничение | |
| __set(строка $option, смешанный $value) Устанавливает значение отложенно инициализированного параметра. | от Ограничение | |
| смешанный | __get(строка $option) Возвращает значение отложенно инициализированного параметра. | от Ограничение |
| addImplicitGroupName(строка $group) Добавляет заданную группу, если это ограничение находится в группе По умолчанию. | от Ограничение | |
| строка | getDefaultOption() Возвращает имя параметра по умолчанию. | |
| массив | getRequiredOptions() Возвращает имена обязательных параметров. | |
| строка | validatedBy() Валидатор должен быть определен как служба с этим именем. | |
| строка|массив | getTargets() Возвращает, можно ли ограничение применять к классам, свойствам или обоим. | |
| массив | __sleep() Оптимизирует сериализованное значение для минимизации занимаемого места. | от Ограничение |
Подробности
static строка getErrorName(int $errorCode)
Возвращает имя данного кода ошибки.
Параметры
| int | $errorCode | Код ошибки |
Возвращаемое значение
| строка | Имя кода ошибки |
Исключения
| ИсключениеНедействительногоАргумента | Если код ошибки не существует |
__construct(смешанный $options = null)
Инициализирует ограничение с параметрами.
Вы должны передать ассоциативный массив. Ключи должны быть именами существующих свойств в этом классе. Значения должны быть значениями для этих свойств.
В качестве альтернативы вы можете переопределить метод getDefaultOption(), чтобы вернуть имя существующего свойства. Если не передается ассоциативный массив, устанавливается это свойство.
Вы можете принудительно установить определенные параметры, переопределив getRequiredOptions(), чтобы вернуть имена этих параметров. Если какой-либо параметр не установлен здесь, вызывается исключение.
Параметры
| смешанный | $options | Параметры (как ассоциативный массив) или значение для параметра по умолчанию (любой другой тип) |
Исключения
| ИсключениеНеверныхПараметров | При передаче имен несуществующих параметров |
| ИсключениеОтсутствующихПараметров | Когда вы не передаете ни одного из параметров, возвращаемых getRequiredOptions() |
| ИсключениеОпределенияОграничения | Когда вы не передаете ассоциативный массив, но getDefaultOption() возвращает null |
__set(строка $option, смешанный $value)
Устанавливает значение отложенно инициализированного параметра.
Соответствующие свойства добавляются в объект при первом доступе. Таким образом, этот метод будет вызван не более одного раза на экземпляр ограничения и имя параметра.
Параметры
| строка | $option | Имя параметра |
| смешанный | $value | Значение для установки |
Исключения
| ИсключениеНеверныхПараметров | Если задано неверное имя параметра |
смешанный __get(строка $option)
Возвращает значение отложенно инициализированного параметра.
Соответствующие свойства добавляются в объект при первом доступе. Таким образом, этот метод будет вызван не более одного раза на экземпляр ограничения и имя параметра.
Параметры
| строка | $option | Имя параметра |
Возвращаемое значение
| смешанный | Значение параметра |
Исключения
| ИсключениеНеверныхПараметров | Если задано неверное имя параметра |
addImplicitGroupName(строка $group)
Добавляет заданную группу, если это ограничение находится в группе По умолчанию.
Параметры
| строка | $group |
строка getDefaultOption()
Возвращает имя параметра по умолчанию.
Переопределите этот метод, чтобы определить параметр по умолчанию.
Возвращаемое значение
| строка |
массив getRequiredOptions()
Возвращает имена обязательных параметров.
Переопределите этот метод, если хотите определить обязательные параметры.
Возвращаемое значение
| массив |
строка validatedBy()
Валидатор должен быть определен как служба с этим именем.
Возвращаемое значение
| строка |
строка|массив getTargets()
Возвращает, можно ли ограничение применять к классам, свойствам или обоим.
Этот метод должен вернуть одно или несколько значений констант Constraint::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.
Возвращаемое значение
| строка|массив | Одно или несколько значений констант |
массив __sleep()
Оптимизирует сериализованное значение для минимизации занимаемого места.
Возвращаемое значение
| массив | Свойства для сериализации |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Bridge/Doctrine/Validator/Constraints/UniqueEntity.html