Spec-Zone.ru › Symfony 3.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
RATIO_TOO_BIG_ERROR
RATIO_TOO_SMALL_ERROR
SQUARE_NOT_ALLOWED_ERROR
LANDSCAPE_NOT_ALLOWED_ERROR
PORTRAIT_NOT_ALLOWED_ERROR
CORRUPTED_IMAGE_ERROR

Свойства

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

Методы

static string getErrorName(string $errorCode)

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

из Ограничение
__construct(mixed $options = null)

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

из Файл
__set(string $option, mixed $value)

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

из Файл
mixed __get(string $option)

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

из Файл
addImplicitGroupName(string $group)

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

из Ограничение
string getDefaultOption()

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

из Ограничение
array getRequiredOptions()

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

из Ограничение
string validatedBy()

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

из Ограничение
string|array getTargets()

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

из Ограничение
array __sleep()

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

из Ограничение

Подробности

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 Если указано некорректное имя параметра

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/3.1/Symfony/Component/Validator/Constraints/Image.html

Spec-Zone.ru

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