Spec-Zone.ru › Symfony 3.1

AbstractComparison

class AbstractComparison extends Constraint

Используется для сравнения значений.

Постоянные

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

Свойства

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

Методы

static string getErrorName(int $errorCode)

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

из Constraint
__construct(mixed $options = null)

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

__set(string $option, mixed $value)

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

из Constraint
mixed __get(string $option)

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

из Constraint
addImplicitGroupName(string $group)

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

из Constraint
string getDefaultOption()

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

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)

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

Параметры

string $group

string getDefaultOption()

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

Переопределите этот метод для определения параметра по умолчанию.

Значение возврата

string

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

Spec-Zone.ru

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