Spec-Zone.ru › Symfony 2.7

УникальныйСущность

класс УникальныйСущность расширяет Ограничение

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

Постоянные

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

Свойства

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

Методы

static string getErrorName(int $errorCode)

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

из Ограничение
__construct(mixed $options = null)

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

из Ограничение
__set(string $option, mixed $value)

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

из Ограничение
mixed __get(string $option)

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

из Ограничение
addImplicitGroupName(string $group)

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

из Ограничение
string getDefaultOption()

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

array getRequiredOptions()

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

string validatedBy()

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

string|array getTargets()

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

array __sleep()

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

из Ограничение

Подробности

static string getErrorName(int $errorCode)

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

Параметры

int $errorCode Код ошибки

Значение возврата

string Имя кода ошибки

Исключения

ИсключениеНекорректногоАргумента Если код ошибки не существует

__construct(mixed $options = null)

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

Вы должны передать ассоциативный массив. Ключи должны быть именами существующих свойств в этом классе. Значения должны быть значениями для этих свойств.

В качестве альтернативы вы можете переопределить метод getDefaultOption(), чтобы вернуть имя существующего свойства. Если не передается ассоциативный массив, вместо него устанавливается это свойство.

Вы можете принудительно установить определенные параметры, переопределив getRequiredOptions(), чтобы вернуть имена этих параметров. Если какой-либо параметр не задан здесь, генерируется исключение.

Параметры

mixed $options Параметры (как ассоциативный массив) или значение для параметра по умолчанию (любой другой тип)

Исключения

ИсключениеНекорректныхПараметров Когда вы передаете имена несуществующих параметров
ИсключениеОтсутствующихПараметров Когда вы не передаете ни одного из параметров, возвращаемых getRequiredOptions()
ИсключениеОпределенияОграничения Когда вы не передаете ассоциативный массив, но getDefaultOption() возвращает null

__set(string $option, mixed $value)

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

Соответствующие свойства добавляются в объект при первом доступе. Таким образом, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя параметра.

Параметры

string $option Имя параметра
mixed $value Значение для установки

Исключения

ИсключениеНекорректныхПараметров Если задано некорректное имя параметра

mixed __get(string $option)

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

Соответствующие свойства добавляются в объект при первом доступе. Таким образом, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя параметра.

Параметры

string $option Имя параметра

Значение возврата

mixed Значение параметра

Исключения

ИсключениеНекорректныхПараметров Если задано некорректное имя параметра

addImplicitGroupName(string $group)

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

Параметры

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

Spec-Zone.ru

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