Class yii\validators\FileValidator

Whether to check file type (extension) with mime-type. If extension produced by file mime-type check differs from uploaded file extension, the file will be considered as invalid.

A list of file name extensions that are allowed to be uploaded. This can be either an array or a string consisting of file extension names separated by space or comma (e.g. "gif, jpg"). Extension names are case-insensitive. Defaults to null, meaning all file name extensions are allowed.

See also $wrongExtension for the customized message for wrong file type.

The maximum file count the given attribute can hold. Defaults to 1, meaning single file upload. By defining a higher number, multiple uploads become possible. Setting it to 0 means there is no limit on the number of files that can be uploaded simultaneously.

Note: The maximum number of files allowed to be uploaded simultaneously is also limited with PHP directive max_file_uploads, which defaults to 20.

See also:

• https://secure.php.net/manual/en/ini.core.php#ini.max-file-uploads
• $tooMany for the customized message when too many files are uploaded.

The maximum number of bytes required for the uploaded file. Defaults to null, meaning no limit. Note, the size limit is also affected by upload_max_filesize and post_max_size INI setting and the 'MAX_FILE_SIZE' hidden field value. See getSizeLimit() for details.

See also:

• https://secure.php.net/manual/en/ini.core.php#ini.upload-max-filesize
• https://secure.php.net/post-max-size
• getSizeLimit()
• $tooBig for the customized message for a file that is too big.

The error message used when a file is not uploaded correctly.

A list of file MIME types that are allowed to be uploaded. This can be either an array or a string consisting of file MIME types separated by space or comma (e.g. "text/plain, image/png"). The mask with the special character * can be used to match groups of mime types. For example image/* will pass all mime types, that begin with image/ (e.g. image/jpeg, image/png). Mime type names are case-insensitive. Defaults to null, meaning all MIME types are allowed.

See also $wrongMimeType for the customized message for wrong MIME type.

The minimum file count the given attribute can hold. Defaults to 0. Higher value means at least that number of files should be uploaded.

See also $tooFew for the customized message when too few files are uploaded.

The minimum number of bytes required for the uploaded file. Defaults to null, meaning no limit.

See also $tooSmall for the customized message for a file that is too small.

The error message used when the uploaded file is too large. You may use the following tokens in the message:

• {attribute}: the attribute name
• {file}: the uploaded file name
• {limit}: the maximum size allowed (see getSizeLimit())
• {formattedLimit}: the maximum size formatted with Formatter::asShortSize()

The error message used if the count of multiple uploads less that minFiles. You may use the following tokens in the message:

• {attribute}: the attribute name
• {limit}: the value of $minFiles

The error message used if the count of multiple uploads exceeds limit. You may use the following tokens in the message:

• {attribute}: the attribute name
• {limit}: the value of $maxFiles

The error message used when the uploaded file is too small. You may use the following tokens in the message:

• {attribute}: the attribute name
• {file}: the uploaded file name
• {limit}: the value of $minSize
• {formattedLimit}: the value of $minSize formatted with [[\yii\i18n\Formatter::asShortSize()|Formatter::asShortSize()]

The error message used when no file is uploaded. Note that this is the text of the validation error message. To make uploading files required, you have to set $skipOnEmpty to false.

The error message used when the uploaded file has an extension name that is not listed in $extensions. You may use the following tokens in the message:

• {attribute}: the attribute name
• {file}: the uploaded file name
• {extensions}: the list of the allowed extensions.

The error message used when the file has an mime type that is not allowed by $mimeTypes property. You may use the following tokens in the message:

• {attribute}: the attribute name
• {file}: the uploaded file name
• {mimeTypes}: the value of $mimeTypes