Spec-Zone.ru › Symfony 4.1

Изображение

класс Изображение расширяет Файл

Константы

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

NOT_FOUND_ERROR
NOT_READABLE_ERROR
EMPTY_ERROR
TOO_LARGE_ERROR
INVALID_MIME_TYPE_ERROR
SIZE_NOT_DETECTED_ERROR
TOO_WIDE_ERROR
TOO_NARROW_ERROR
TOO_HIGH_ERROR
TOO_LOW_ERROR
TOO_FEW_PIXEL_ERROR
TOO_MANY_PIXEL_ERROR
RATIO_TOO_BIG_ERROR
RATIO_TOO_SMALL_ERROR
SQUARE_NOT_ALLOWED_ERROR
LANDSCAPE_NOT_ALLOWED_ERROR
PORTRAIT_NOT_ALLOWED_ERROR
CORRUPTED_IMAGE_ERROR

Свойства

статический защищенный $errorNames
смешанный $payload Данные, специфичные для домена, прикрепленные к ограничению. из Ограничение
массив $groups Группы, к которым относится ограничение из Ограничение
$binaryFormat из Файл
$mimeTypes
$notFoundMessage из Файл
$notReadableMessage из Файл
$maxSizeMessage из Файл
$mimeTypesMessage
$disallowEmptyMessage из Файл
$uploadIniSizeErrorMessage из Файл
$uploadFormSizeErrorMessage из Файл
$uploadPartialErrorMessage из Файл
$uploadNoFileErrorMessage из Файл
$uploadNoTmpDirErrorMessage из Файл
$uploadCantWriteErrorMessage из Файл
$uploadExtensionErrorMessage из Файл
$uploadErrorMessage из Файл
целое число $maxSize из Файл
$minWidth
$maxWidth
$maxHeight
$minHeight
$maxRatio
$minRatio
$minPixels
$maxPixels
$allowSquare
$allowLandscape
$allowPortrait
$detectCorrupted
$sizeNotDetectedMessage
$maxWidthMessage
$minWidthMessage
$maxHeightMessage
$minHeightMessage
$minPixelsMessage
$maxPixelsMessage
$maxRatioMessage
$minRatioMessage
$allowSquareMessage
$allowLandscapeMessage
$allowPortraitMessage
$corruptedMessage

Методы

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

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

из Constraint
__construct(mixed $options = null)

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

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

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

из File
mixed __get(string $option)

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

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

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

из Constraint
string getDefaultOption()

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

из Constraint
array getRequiredOptions()

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

из Constraint
string validatedBy()

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

из Constraint
string|array getTargets()

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

из Constraint
array __sleep()

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

из Constraint

Подробности

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)

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

Параметры

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.
https://api.symfony.com/4.1/Symfony/Component/Validator/Constraints/Image.html

Spec-Zone.ru

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