ImageValidator

API reference › yii › validators › ImageValidator

class	`yii\validators\ImageValidator`
Extends	`FileValidator` » `Validator` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`framework/validators/ImageValidator.php`

ImageValidator verifies if an attribute is receiving a valid image.

Properties

Property	Type	Description	Defined by
`$attributeNames` read-only	`array`	Attribute names.	`Validator`
`$attributes`	`array\|string`	Attributes to be validated by this validator. Default: `[]`.	`Validator`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$builtInValidators` static	`array`	List of built-in validators (name => class or configuration) Default: ['boolean' => 'yii\validators\BooleanValidator', 'captcha' => 'yii\captcha\CaptchaValidator', 'compare' => 'yii\validators\CompareValidator', 'date' => 'yii\validators\DateValidator', 'datetime' => ['class' => 'yii\validators\DateValidator', 'type' => \yii\validators\DateValidator::TYPE_DATETIME], 'time' => ['class' => 'yii\validators\DateValidator', 'type' => \yii\validators\DateValidator::TYPE_TIME], 'default' => 'yii\validators\DefaultValueValidator', 'double' => 'yii\validators\NumberValidator', 'each' => 'yii\validators\EachValidator', 'email' => 'yii\validators\EmailValidator', 'exist' => 'yii\validators\ExistValidator', 'file' => 'yii\validators\FileValidator', 'filter' => 'yii\validators\FilterValidator', 'image' => 'yii\validators\ImageValidator', 'in' => 'yii\validators\RangeValidator', 'integer' => ['class' => 'yii\validators\NumberValidator', 'integerOnly' => true], 'match' => 'yii\validators\RegularExpressionValidator', 'number' => 'yii\validators\NumberValidator', 'required' => 'yii\validators\RequiredValidator', 'safe' => 'yii\validators\SafeValidator', 'string' => 'yii\validators\StringValidator', 'trim' => ['class' => 'yii\validators\TrimValidator', 'skipOnArray' => true], 'unique' => 'yii\validators\UniqueValidator', 'url' => 'yii\validators\UrlValidator', 'ip' => 'yii\validators\IpValidator'].	`Validator`
`$checkExtensionByMimeType`	`bool`	Whether to check file type (extension) with mime-type. Default: `true`.	`FileValidator`
`$clientScript`	`array\|yii\validators\client\ClientValidatorScriptInterface\|null`	Client script class to use for client-side validation. Default: `null`.	`ImageValidator`
`$enableClientValidation`	`bool`	Whether to enable client-side validation for this validator. Default: `true`.	`Validator`
`$except`	`array\|string`	Scenarios that the validator should not be applied to. Default: `[]`.	`Validator`
`$extensions`	`array\|string\|null`	A list of file name extensions that are allowed to be uploaded. Default: `null`.	`FileValidator`
`$isEmpty`	`callable\|null`	A PHP callable that replaces the default implementation of `isEmpty()`. Default: `null`.	`Validator`
`$maxFiles`	`int`	The maximum file count the given attribute can hold. Default: `1`.	`FileValidator`
`$maxHeight`	`int\|null`	The maximum width in pixels. Default: `null`.	`ImageValidator`
`$maxSize`	`int\|null`	The maximum number of bytes required for the uploaded file. Default: `null`.	`FileValidator`
`$maxWidth`	`int\|null`	The maximum width in pixels. Default: `null`.	`ImageValidator`
`$message`	`string`	The error message used when a file is not uploaded correctly. Default: `null`.	`FileValidator`
`$mimeTypes`	`array\|string\|null`	A list of file MIME types that are allowed to be uploaded. Default: `null`.	`FileValidator`
`$minFiles`	`int`	The minimum file count the given attribute can hold. Default: `0`. Available since 2.0.14.	`FileValidator`
`$minHeight`	`int\|null`	The minimum height in pixels. Default: `null`.	`ImageValidator`
`$minSize`	`int\|null`	The minimum number of bytes required for the uploaded file. Default: `null`.	`FileValidator`
`$minWidth`	`int\|null`	The minimum width in pixels. Default: `null`.	`ImageValidator`
`$notImage`	`string`	The error message used when the uploaded file is not an image. Default: `null`.	`ImageValidator`
`$on`	`array\|string`	Scenarios that the validator can be applied to. Default: `[]`.	`Validator`
`$overHeight`	`string`	The error message used when the image is over `$maxHeight`. Default: `null`.	`ImageValidator`
`$overWidth`	`string`	The error message used when the image is over `$maxWidth`. Default: `null`.	`ImageValidator`
`$sizeLimit` read-only	`int`	The size limit for uploaded files.	`FileValidator`
`$skipOnEmpty`	`bool`	Whether this validation rule should be skipped if the attribute value is null or an empty string. Default: `true`.	`Validator`
`$skipOnError`	`bool`	Whether this validation rule should be skipped if the attribute being validated already has some validation error according to some previous rules. Default: `true`.	`Validator`
`$tooBig`	`string`	The error message used when the uploaded file is too large. Default: `null`.	`FileValidator`
`$tooFew`	`string`	The error message used if the count of multiple uploads less that minFiles. Default: `null`. Available since 2.0.14.	`FileValidator`
`$tooMany`	`string`	The error message used if the count of multiple uploads exceeds limit. Default: `null`.	`FileValidator`
`$tooSmall`	`string`	The error message used when the uploaded file is too small. Default: `null`.	`FileValidator`
`$underHeight`	`string`	The error message used when the image is under `$minHeight`. Default: `null`.	`ImageValidator`
`$underWidth`	`string`	The error message used when the image is under `$minWidth`. Default: `null`.	`ImageValidator`
`$uploadRequired`	`string`	The error message used when no file is uploaded. Default: `null`.	`FileValidator`
`$validationAttributes` read-only	`array\|null`	List of attribute names.	`Validator`
`$when`	`callable\|null`	A PHP callable whose return value determines whether this validator should be applied. Default: `null`.	`Validator`
`$whenClient`	`string\|null`	A JavaScript function name whose return value determines whether this validator should be applied on the client-side. Default: `null`.	`Validator`
`$wrongExtension`	`string`	The error message used when the uploaded file has an extension name that is not listed in `$extensions`. Default: `null`.	`FileValidator`
`$wrongMimeType`	`string`	The error message used when the file has an mime type that is not allowed by `$mimeTypes` property. Default: `null`.	`FileValidator`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`addError()`	Adds an error about the specified attribute to the model object.	`Validator`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`clientValidateAttribute()`	Returns the JavaScript needed for performing client-side validation.	`FileValidator`
`createValidator()` static	Creates a validator object.	`Validator`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`getAttributeNames()`	Returns cleaned attribute names without the `!` character at the beginning.	`Validator`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getClientOptions()`	Returns the client-side validation options.	`FileValidator`
`getFormattedClientMessage()`	Returns the formatted validation message for client-side validation.	`Validator`
`getSizeLimit()`	Returns the maximum size allowed for uploaded files.	`FileValidator`
`getValidationAttributes()`	Returns a list of attributes this validator applies to.	`Validator`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the object.	`ImageValidator`
`isActive()`	Returns a value indicating whether the validator is active for the given scenario and attribute.	`Validator`
`isEmpty()`	Checks if the given value is empty.	`FileValidator`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`trigger()`	Triggers an event.	`yii\base\Component`
`validate()`	Validates a given value.	`Validator`
`validateAttribute()`	Validates a single attribute.	`FileValidator`
`validateAttributes()`	Validates the specified object.	`Validator`
`formatMessage()` protected	Formats a mesage using the I18N, or simple strtr if `\Yii::$app` is not available.	`Validator`
`getMimeTypeByFile()` protected	Get MIME type by file path	`FileValidator`
`validateExtension()` protected	Checks if given uploaded file have correct type (extension) according current validator settings.	`FileValidator`
`validateImage()` protected	Validates an image file.	`ImageValidator`
`validateMimeType()` protected	Checks the mimeType of the $file against the list in the `$mimeTypes` property.	`FileValidator`
`validateValue()` protected	Validates a value.	`ImageValidator`

Property details

$maxHeight

public int|null $maxHeight = null

The maximum width in pixels.

Defaults to null, meaning no limit.

$maxWidth

public int|null $maxWidth = null

The maximum width in pixels.

Defaults to null, meaning no limit.

$minHeight

public int|null $minHeight = null

The minimum height in pixels.

Defaults to null, meaning no limit.

$minWidth

public int|null $minWidth = null

The minimum width in pixels.

Defaults to null, meaning no limit.