Spec-Zone.ru › Symfony 2.7

Страна

класс Страна расширяет Constraint

Константы

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

Свойства

смешанный $payload Данные, специфичные для домена, присоединённые к ограничению. из Constraint
массив $groups Группы, к которым относится ограничение из Constraint
$message

Методы

статический string getErrorName(int $errorCode)

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

из Constraint
__construct(mixed $options = null)

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

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

Устанавливает значение параметра, инициализируемого в процессе работы.

из Constraint
смешанный __get(string $option)

Возвращает значение параметра, инициализируемого в процессе работы.

из Constraint
addImplicitGroupName(string $group)

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

из Constraint
string getDefaultOption()

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

из Constraint
массив getRequiredOptions()

Возвращает имя необходимых параметров.

из Constraint
string validatedBy()

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

из Constraint
string|массив getTargets()

Возвращает, может ли ограничение быть применено к классам, свойствам или обоим.

из Constraint
массив __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::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.

Значение результата

string|array Одно или несколько значений констант

array __sleep()

Оптимизирует сериализованное значение для минимизации места хранения.

Значение результата

array Свойства для сериализации

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Validator/Constraints/Country.html

Spec-Zone.ru

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