Class yii\validators\ImageValidator
| Inheritance | yii\validators\ImageValidator » yii\validators\FileValidator » yii\validators\Validator » yii\base\Component » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/validators/ImageValidator.php |
ImageValidator verifies if an attribute is receiving a valid image.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attributeNames | array | Attribute names. | yii\validators\Validator |
| $attributes | array|string | Attributes to be validated by this validator. | yii\validators\Validator |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $builtInValidators | array | List of built-in validators (name => class or configuration) | yii\validators\Validator |
| $checkExtensionByMimeType | boolean | Whether to check file type (extension) with mime-type. | yii\validators\FileValidator |
| $enableClientValidation | boolean | Whether to enable client-side validation for this validator. | yii\validators\Validator |
| $except | array|string | Scenarios that the validator should not be applied to. | yii\validators\Validator |
| $extensions | array|string | A list of file name extensions that are allowed to be uploaded. | yii\validators\FileValidator |
| $isEmpty | callable | A PHP callable that replaces the default implementation of isEmpty(). | yii\validators\Validator |
| $maxFiles | integer | The maximum file count the given attribute can hold. | yii\validators\FileValidator |
| $maxHeight | integer | The maximum width in pixels. | yii\validators\ImageValidator |
| $maxSize | integer | The maximum number of bytes required for the uploaded file. | yii\validators\FileValidator |
| $maxWidth | integer | The maximum width in pixels. | yii\validators\ImageValidator |
| $message | string | The error message used when a file is not uploaded correctly. | yii\validators\FileValidator |
| $mimeTypes | array|string | A list of file MIME types that are allowed to be uploaded. | yii\validators\FileValidator |
| $minHeight | integer | The minimum height in pixels. | yii\validators\ImageValidator |
| $minSize | integer | The minimum number of bytes required for the uploaded file. | yii\validators\FileValidator |
| $minWidth | integer | The minimum width in pixels. | yii\validators\ImageValidator |
| $notImage | string | The error message used when the uploaded file is not an image. | yii\validators\ImageValidator |
| $on | array|string | Scenarios that the validator can be applied to. | yii\validators\Validator |
| $overHeight | string | The error message used when the image is over $maxHeight. | yii\validators\ImageValidator |
| $overWidth | string | The error message used when the image is over $maxWidth. | yii\validators\ImageValidator |
| $sizeLimit | integer | The size limit for uploaded files. | yii\validators\FileValidator |
| $skipOnEmpty | boolean | Whether this validation rule should be skipped if the attribute value is null or an empty string. | yii\validators\Validator |
| $skipOnError | boolean | Whether this validation rule should be skipped if the attribute being validated already has some validation error according to some previous rules. | yii\validators\Validator |
| $tooBig | string | The error message used when the uploaded file is too large. | yii\validators\FileValidator |
| $tooMany | string | The error message used if the count of multiple uploads exceeds limit. | yii\validators\FileValidator |
| $tooSmall | string | The error message used when the uploaded file is too small. | yii\validators\FileValidator |
| $underHeight | string | The error message used when the image is under $minHeight. | yii\validators\ImageValidator |
| $underWidth | string | The error message used when the image is under $minWidth. | yii\validators\ImageValidator |
| $uploadRequired | string | The error message used when no file is uploaded. | yii\validators\FileValidator |
| $when | callable | A PHP callable whose return value determines whether this validator should be applied. | yii\validators\Validator |
| $whenClient | string | A JavaScript function name whose return value determines whether this validator should be applied on the client-side. | yii\validators\Validator |
| $wrongExtension | string | The error message used when the uploaded file has an extension name that is not listed in $extensions. | yii\validators\FileValidator |
| $wrongMimeType | string | The error message used when the file has an mime type that is not allowed by $mimeTypes property. | yii\validators\FileValidator |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __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 |
| __construct() | Constructor. | yii\base\Object |
| __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. | yii\validators\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() | Returns the fully qualified name of this class. | yii\base\Object |
| clientValidateAttribute() | Returns the JavaScript needed for performing client-side validation. | yii\validators\ImageValidator |
| createValidator() | Creates a validator object. | yii\validators\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 | yii\validators\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. | yii\validators\ImageValidator |
| getSizeLimit() | Returns the maximum size allowed for uploaded files. | yii\validators\FileValidator |
| 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. | yii\validators\ImageValidator |
| isActive() | Returns a value indicating whether the validator is active for the given scenario and attribute. | yii\validators\Validator |
| isEmpty() | Checks if the given value is empty. | yii\validators\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. | yii\validators\Validator |
| validateAttribute() | Validates a single attribute. | yii\validators\FileValidator |
| validateAttributes() | Validates the specified object. | yii\validators\Validator |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| formatMessage() | Formats a mesage using the I18N, or simple strtr if \Yii::$app is not available. | yii\validators\Validator |
| validateExtension() | Checks if given uploaded file have correct type (extension) according current validator settings. | yii\validators\FileValidator |
| validateImage() | Validates an image file. | yii\validators\ImageValidator |
| validateMimeType() | Checks the mimeType of the $file against the list in the $mimeTypes property | yii\validators\FileValidator |
| validateValue() | Validates a value. | yii\validators\ImageValidator |
Property Details
$maxHeight public property
The maximum width in pixels. Defaults to null, meaning no limit.
See also $overWidth for the customized message used when image height is too big.
public integer $maxHeight = null
$maxWidth public property
The maximum width in pixels. Defaults to null, meaning no limit.
See also $overWidth for the customized message used when image width is too big.
public integer $maxWidth = null
$minHeight public property
The minimum height in pixels. Defaults to null, meaning no limit.
See also $underHeight for the customized message used when image height is too small.
public integer $minHeight = null
$minWidth public property
The minimum width in pixels. Defaults to null, meaning no limit.
See also $underWidth for the customized message used when image width is too small.
public integer $minWidth = null
$notImage public property
The error message used when the uploaded file is not an image. You may use the following tokens in the message:
- {attribute}: the attribute name
- {file}: the uploaded file name
public string $notImage = null
$overHeight public property
The error message used when the image is over $maxHeight. You may use the following tokens in the message:
- {attribute}: the attribute name
- {file}: the uploaded file name
- {limit}: the value of $maxHeight
public string $overHeight = null
$overWidth public property
The error message used when the image is over $maxWidth. You may use the following tokens in the message:
- {attribute}: the attribute name
- {file}: the uploaded file name
- {limit}: the value of $maxWidth
public string $overWidth = null
$underHeight public property
The error message used when the image is under $minHeight. You may use the following tokens in the message:
- {attribute}: the attribute name
- {file}: the uploaded file name
- {limit}: the value of $minHeight
public string $underHeight = null
$underWidth public property
The error message used when the image is under $minWidth. You may use the following tokens in the message:
- {attribute}: the attribute name
- {file}: the uploaded file name
- {limit}: the value of $minWidth
public string $underWidth = null
Method Details
clientValidateAttribute() public method
Returns the JavaScript needed for performing client-side validation.
Calls getClientOptions() to generate options array for client-side validation.
You may override this method to return the JavaScript validation code if the validator can support client-side validation.
The following JavaScript variables are predefined and can be used in the validation code:
-
attribute: an object describing the the attribute being validated. -
value: the value being validated. -
messages: an array used to hold the validation error messages for the attribute. -
deferred: an array used to hold deferred objects for asynchronous validation -
$form: a jQuery object containing the form element
The attribute object contains the following properties:
-
id: a unique ID identifying the attribute (e.g. "loginform-username") in the form -
name: attribute name or expression (e.g. "[0]content" for tabular input) -
container: the jQuery selector of the container of the input field -
input: the jQuery selector of the input field under the context of the form -
error: the jQuery selector of the error tag under the context of the container -
status: status of the input field, 0: empty, not entered before, 1: validated, 2: pending validation, 3: validating
| public string|null clientValidateAttribute ( $model, $attribute, $view ) | ||
|---|---|---|
| $model | yii\base\Model |
The data model being validated |
| $attribute | string |
The name of the attribute to be validated. |
| $view | yii\web\View |
The view object that is going to be used to render views or view files containing a model form with this validator applied. |
| return | string|null |
The client-side validation script. Null if the validator does not support client-side validation. |
getClientOptions() public method
Returns the client-side validation options.
This method is usually called from clientValidateAttribute(). You may override this method to modify options that will be passed to the client-side validation.
| public array getClientOptions ( $model, $attribute ) | ||
|---|---|---|
| $model | yii\base\Model |
The model being validated |
| $attribute | string |
The attribute name being validated |
| return | array |
The client-side validation options |
init() public method
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
| public void init ( ) |
|---|
validateImage() protected method
Validates an image file.
| protected array|null validateImage ( $image ) | ||
|---|---|---|
| $image | yii\web\UploadedFile |
Uploaded file passed to check against a set of rules |
| return | array|null |
The error message and the parameters to be inserted into the error message. Null should be returned if the data is valid. |
validateValue() protected method
Validates a value.
A validator class can implement this method to support data validation out of the context of a data model.
| protected array|null validateValue ( $value ) | ||
|---|---|---|
| $value | mixed |
The data value to be validated. |
| return | array|null |
The error message and the parameters to be inserted into the error message. Null should be returned if the data is valid. |
| throws | yii\base\NotSupportedException |
if the validator does not supporting data validation without a model |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-validators-imagevalidator.html