Issn
class Issn extends Constraint
Постоянные значения
| DEFAULT_GROUP | Имя группы, присваиваемой всем ограничениям без явного указания. |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам. |
| TOO_SHORT_ERROR | |
| TOO_LONG_ERROR | |
| MISSING_HYPHEN_ERROR | |
| INVALID_CHARACTERS_ERROR | |
| INVALID_CASE_ERROR | |
| CHECKSUM_FAILED_ERROR |
Свойства
| mixed | $payload | Данные, специфичные для домена, присоединенные к ограничению. | from Constraint |
| array | $groups | Группы, к которым относится ограничение. | from Constraint |
| $message | |||
| $caseSensitive | |||
| $requireHyphen |
Методы
| static string | getErrorName(int $errorCode) Возвращает имя заданного кода ошибки. | from Constraint |
| __construct(mixed $options = null) Инициализирует ограничение параметрами. | from Constraint | |
| __set(string $option, mixed $value) Устанавливает значение лениво инициализированного параметра. | from Constraint | |
| mixed | __get(string $option) Возвращает значение лениво инициализированного параметра. | from Constraint |
| addImplicitGroupName(string $group) Добавляет заданную группу, если это ограничение находится в группе Default. | from Constraint | |
| string | getDefaultOption() Возвращает имя параметра по умолчанию. | from Constraint |
| array | getRequiredOptions() Возвращает имена необходимых параметров. | from Constraint |
| string | validatedBy() Возвращает имя класса, который валидирует данное ограничение. | from Constraint |
| string|array | getTargets() Возвращает, может ли ограничение быть применено к классам, свойствам или обоим. | from Constraint |
| array | __sleep() Оптимизирует сериализованное значение для минимизации занимаемого места. | from 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)
Добавляет заданную группу, если это ограничение находится в группе Default.
Параметры
| 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.0/Symfony/Component/Validator/Constraints/Issn.html