Spec-Zone.ru › Symfony 3.2

Изображение

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

Константы

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

Свойства

смешанный $payload Данные, специфичные для домена, прикрепленные к ограничению. из Ограничение
массив $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

Методы

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

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

из Ограничение
__construct(смешанный $options = null)

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

из Файл
__set(строка $option, смешанный $value)

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

из Файл
смешанный __get(строка $option)

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

из Файл
addImplicitGroupName(строка $group)

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

из Ограничение
строка getDefaultOption()

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

из Ограничение
массив getRequiredOptions()

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

из Ограничение
строка validatedBy()

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

из Ограничение
строка|массив getTargets()

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

из Ограничение
массив __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.2/Symfony/Component/Validator/Constraints/Image.html

Spec-Zone.ru

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