UserPassword
class UserPassword extends Constraint
Постоянные значения
| DEFAULT_GROUP | Имя группы, присваиваемое всем ограничениям без явного указания группы. |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам. |
Свойства
| static protected | $errorNames | Сопоставление кодов ошибок с именами их констант. | from Constraint |
| mixed | $payload | Данные, специфичные для области, прикреплённые к ограничению. | from Constraint |
| array | $groups | Группы, к которым относится ограничение | from Constraint |
| $message | |||
| $service |
Методы
| static string | getErrorName(string $errorCode) Возвращает имя заданного кода ошибки. | from Constraint |
| __construct(mixed $options = null) Инициализирует ограничение с параметрами. | from Constraint | |
| __set(string $option, mixed $value) Устанавливает значение параметра с отложенной инициализацией. | from Constraint | |
| mixed | __get(string $option) Возвращает значение параметра с отложенной инициализацией. | from Constraint |
| bool | __isset(string $option) | from Constraint |
| addImplicitGroupName(string $group) Добавляет заданную группу, если это ограничение находится в группе По умолчанию. | from Constraint | |
| string | getDefaultOption() Возвращает имя параметра по умолчанию. | from Constraint |
| array | getRequiredOptions() Возвращает имя обязательных параметров. | from Constraint |
| string | validatedBy() Возвращает имя класса, который проверяет это ограничение. | |
| string|array | getTargets() Возвращает, можно ли применить ограничение к классам, свойствам или обоим. | from Constraint |
| array | __sleep() Оптимизирует сериализованное значение для минимизации занимаемого места. | from 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 | Если указано неверное имя параметра |
bool __isset(string $option)
Параметры
| string | $option | Имя параметра |
Возвращаемое значение
| bool |
addImplicitGroupName(string $group)
Добавляет заданную группу, если это ограничение находится в группе По умолчанию.
Параметры
| string | $group |
string getDefaultOption()
Возвращает имя параметра по умолчанию.
Переопределите этот метод для определения параметра по умолчанию.
Возвращаемое значение
| string |
См. также
| __construct() |
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.
https://api.symfony.com/4.1/Symfony/Component/Security/Core/Validator/Constraints/UserPassword.html