Страна
класс Страна расширяет Constraint
Константы
| DEFAULT_GROUP | Название группы, задаваемое всем ограничениям без явной группы. |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам. |
| NO_SUCH_COUNTRY_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/3.0/Symfony/Component/Validator/Constraints/Country.html