Лухан
класс Luhn расширяет Constraint
Метаданные для LuhnValidator.
Константы
| DEFAULT_GROUP | Имя группы, заданной для всех ограничений без явной группы |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам |
| INVALID_CHARACTERS_ERROR | |
| CHECKSUM_FAILED_ERROR |
Свойства
| mixed | $payload | Данные, специфичные для домена, прикрепленные к ограничению | из Constraint |
| array | $groups | Группы, к которым относится ограничение | из Constraint |
| $message |
Методы
| 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() Возвращает имя класса, который валидирует это ограничение. | из Constraint |
| 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/2.7/Symfony/Component/Validator/Constraints/Luhn.html