Spec-Zone.ru › Symfony 4.1

Все

класс Все расширяет Composite

Константы

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

Свойства

static protected $errorNames Сопоставление кодов ошибок с названиями их констант. из Constraint
mixed $payload Данные, специфичные для домена, прикреплённые к ограничению. из Constraint
array $groups Группы, к которым относится ограничение. из Constraint
$constraints

Методы

static string getErrorName(string $errorCode)

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

из Constraint
__construct(mixed $options = null)

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

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

Устанавливает значение лениво инициализированной опции.

из Constraint
mixed __get(string $option)

Возвращает значение лениво инициализированной опции.

из Constraint
bool __isset(string $option) из Constraint
addImplicitGroupName(string $group)

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

из Composite
string getDefaultOption()

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

array getRequiredOptions()

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

string validatedBy()

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

из Constraint
string|array getTargets()

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

из Constraint
array __sleep()

Оптимизирует сериализованное значение для уменьшения занимаемого места.

из Constraint
string getCompositeOption()

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

initializeNestedConstraints()

Инициализирует вложенные ограничения.

из Composite

Подробности

static string getErrorName(string $errorCode)

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

Параметры

string $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 Если задано неверное имя параметра

bool __isset(string $option)

Параметры

string $option Имя параметра

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

bool

addImplicitGroupName(string $group)

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

Параметры

string $group

string getDefaultOption()

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

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

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

string

array getRequiredOptions()

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

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

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

array

string validatedBy()

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

По умолчанию это полное имя класса ограничения с добавленным "Validator". Вы можете переопределить этот метод, чтобы изменить это поведение.

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

string

string|array getTargets()

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

Этот метод должен вернуть одну или несколько констант Constraint::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.

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

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

array __sleep()

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

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

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

protected string getCompositeOption()

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

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

string Имя свойства

protected initializeNestedConstraints()

Инициализирует вложенные ограничения.

Этот метод может быть переопределен в подклассах для очистки вложенных ограничений, переданных в конструктор.

См. также

Collection::initializeNestedConstraints

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/Constraints/All.html

Spec-Zone.ru

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