Spec-Zone.ru › Symfony 3.2

UserPassword

class UserPassword extends Constraint

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

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

Свойства

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

Методы

static string getErrorName(int $errorCode)

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

из Constraint
__construct(mixed $options = null)

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

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

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

из Constraint
mixed __get(string $option)

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

из Constraint
addImplicitGroupName(string $group)

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

из Constraint
string getDefaultOption()

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

из Constraint
array getRequiredOptions()

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

из Constraint
string validatedBy()

Возвращает имя класса, который валидирует данное ограничение

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

См. также

__construct()

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/Security/Core/Validator/Constraints/UserPassword.html

Spec-Zone.ru

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