Spec-Zone.ru › Symfony 3.0

CardScheme

class CardScheme extends Constraint

Метаданные для CardSchemeValidator.

Постоянные значения

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

NOT_NUMERIC_ERROR
INVALID_FORMAT_ERROR

Свойства

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

Методы

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)

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

из Constraint
string getDefaultOption()

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

array getRequiredOptions()

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

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)

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

Параметры

string $group

string getDefaultOption()

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

Переопределите этот метод, чтобы определить параметр по умолчанию.

Возвращаемое значение

string

array getRequiredOptions()

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

Переопределите этот метод, если хотите определить требуемые параметры.

Возвращаемое значение

array

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/CardScheme.html

Spec-Zone.ru

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