Spec-Zone.ru › Symfony 3.2

UniqueEntity

class UniqueEntity extends Constraint

Ограничение для валидатора уникальности сущности.

Постоянные значения

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

NOT_UNIQUE_ERROR

Свойства

mixed $payload Данные, специфичные для домена, прикрепленные к ограничению. из Constraint
array $groups Группы, к которым относится ограничение из Constraint
$message
$service
$em
$entityClass
$repositoryMethod
$fields
$errorPath
$ignoreNull

Методы

static string getErrorName(string $errorCode)

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

из Constraint
__construct(mixed $options = null)

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

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

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

из Constraint
mixed __get(string $option)

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

из Constraint
addImplicitGroupName(string $group)

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

из Constraint
string getDefaultOption()

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

array getRequiredOptions()

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

string validatedBy()

Валидатор должен быть определен как сервис с этим именем.

string|array getTargets()

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

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)

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

Параметры

string $group

string getDefaultOption()

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

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

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

string

array getRequiredOptions()

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

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

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

array

string validatedBy()

Валидатор должен быть определен как сервис с этим именем.

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

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/3.2/Symfony/Bridge/Doctrine/Validator/Constraints/UniqueEntity.html

Spec-Zone.ru

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