0 follower

CFileValidator

Package system.validators
Inheritance class CFileValidator » CValidator » CComponent
Since 1.0
Version $Id$
Source Code framework/validators/CFileValidator.php
CFileValidator verifies if an attribute is receiving a valid uploaded file.

It uses the model class and attribute name to retrieve the information about the uploaded file. It then checks if a file is uploaded successfully, if the file size is within the limit and if the file type is allowed.

When using CFileValidator with an active record, the following code is often used: 
 // assuming the upload file field is generated using
 // CHtml::activeFileField($model,'file');
 $model->file=CUploadedFile::getInstance($model,'file');
 $model->fileSize=$file->size;
 if($model->save())
     $model->file->saveAs($path); // save the uploaded file


You can use CFileValidator to validate the file attribute.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
allowEmpty boolean whether the attribute requires a file to be uploaded or not. CFileValidator
attributes array list of attributes to be validated. CValidator
builtInValidators array list of built-in validators (name=>class) CValidator
maxSize integer the maximum number of bytes required for the uploaded file. CFileValidator
message string the user-defined error message. CValidator
minSize integer the minimum number of bytes required for the uploaded file. CFileValidator
on array list of scenarios that the validator should be applied. CValidator
tooLarge string the error message used when the uploaded file is too large. CFileValidator
tooSmall string the error message used when the uploaded file is too small. CFileValidator
types mixed a list of file name extensions that are allowed to be uploaded. CFileValidator
wrongType string the error message used when the uploaded file has an extension name that is not listed among extensions. CFileValidator

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
sizeLimit integer Returns the maximum size allowed for uploaded files. CFileValidator

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
applyTo() Returns a value indicating whether the validator applies to the specified scenario. CValidator
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
createValidator() Creates a validator object. CValidator
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
raiseEvent() Raises an event. CComponent
validate() Validates the specified object. CValidator

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
addError() Adds an error about the specified attribute to the active record. CValidator
getSizeLimit() Returns the maximum size allowed for uploaded files. CFileValidator
isEmpty() Checks if the given value is empty. CValidator
validateAttribute() Validates the attribute of the object. CFileValidator

Property Details

allowEmpty property
public boolean $allowEmpty;

whether the attribute requires a file to be uploaded or not. Defaults to false, meaning a file is required to be uploaded.

maxSize property
public integer $maxSize;

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' INI setting and the 'MAX_FILE_SIZE' hidden field value.

See Also

minSize property
public integer $minSize;

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

See Also

sizeLimit property read-only
protected integer getSizeLimit()

Returns the maximum size allowed for uploaded files. This is determined based on three factors:

  • 'upload_max_filesize' in php.ini
  • 'MAX_FILE_SIZE' hidden field
  • maxSize

tooLarge property
public string $tooLarge;

the error message used when the uploaded file is too large.

See Also

tooSmall property
public string $tooSmall;

the error message used when the uploaded file is too small.

See Also

types property
public mixed $types;

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.

wrongType property
public string $wrongType;

the error message used when the uploaded file has an extension name that is not listed among extensions.

Method Details

getSizeLimit() method
protected integer getSizeLimit()
{return} integer the size limit for uploaded files.
Source Code: framework/validators/CFileValidator.php#148 (show)
protected function getSizeLimit()
{
    $limit=ini_get('upload_max_filesize');
    if(strpos($limit,'M')!==false)
        $limit=$limit*1024*1024;
    if($this->maxSize!==null && $limit>0 && $this->maxSize<$limit)
        $limit=$this->maxSize;
    if(isset($_POST['MAX_FILE_SIZE']) && $_POST['MAX_FILE_SIZE']>0 && $_POST['MAX_FILE_SIZE']<$limit)
        $limit=$_POST['MAX_FILE_SIZE'];
    return $limit;
}

Returns the maximum size allowed for uploaded files. This is determined based on three factors:

  • 'upload_max_filesize' in php.ini
  • 'MAX_FILE_SIZE' hidden field
  • maxSize

validateAttribute() method
protected void validateAttribute(CModel $object, string $attribute)
$object CModel the object being validated
$attribute string the attribute being validated
Source Code: framework/validators/CFileValidator.php#86 (show)
protected function validateAttribute($object,$attribute)
{
    $file=$object->$attribute;
    if(!($file instanceof CUploadedFile))
        $file=CUploadedFile::getInstance($object,$attribute);

    if($this->allowEmpty && ($file===null || $file->getError()==UPLOAD_ERR_NO_FILE))
        return;

    if($file===null || $file->getError()==UPLOAD_ERR_NO_FILE)
    {
        $message=$this->message!==null?$this->message : Yii::t('yii','{attribute} cannot be blank.');
        $this->addError($object,$attribute,$message);
        return;
    }

    $error=$file->getError();
    if($error==UPLOAD_ERR_INI_SIZE || $error==UPLOAD_ERR_FORM_SIZE || $this->maxSize!==null && $file->getSize()>$this->maxSize)
    {
        $message=$this->tooLarge!==null?$this->tooLarge : Yii::t('yii','The file "{file}" is too large. Its size cannot exceed {limit} bytes.');
        $this->addError($object,$attribute,$message,array('{file}'=>$file->getName(), '{limit}'=>$this->getSizeLimit()));
    }
    else if($error==UPLOAD_ERR_PARTIAL)
        throw new CException(Yii::t('yii','The file "{file}" was only partially uploaded.',array('{file}'=>$file->getName())));
    else if($error==UPLOAD_ERR_NO_TMP_DIR)
        throw new CException(Yii::t('yii','Missing the temporary folder to store the uploaded file "{file}".',array('{file}'=>$file->getName())));
    else if($error==UPLOAD_ERR_CANT_WRITE)
        throw new CException(Yii::t('yii','Failed to write the uploaded file "{file}" to disk.',array('{file}'=>$file->getName())));
    else if(defined('UPLOAD_ERR_EXTENSION') && $error==UPLOAD_ERR_EXTENSION)  // available for PHP 5.2.0 or above
        throw new CException(Yii::t('yii','File upload was stopped by extension.'));

    if($this->minSize!==null && $file->getSize()<$this->minSize)
    {
        $message=$this->tooSmall!==null?$this->tooSmall : Yii::t('yii','The file "{file}" is too small. Its size cannot be smaller than {limit} bytes.');
        $this->addError($object,$attribute,$message,array('{file}'=>$file->getName(), '{limit}'=>$this->minSize));
    }

    if($this->types!==null)
    {
        if(is_string($this->types))
            $types=preg_split('/[\s,]+/',strtolower($this->types),-1,PREG_SPLIT_NO_EMPTY);
        else
            $types=$this->types;
        if(!in_array(strtolower($file->getExtensionName()),$types))
        {
            $message=$this->wrongType!==null?$this->wrongType : Yii::t('yii','The file "{file}" cannot be uploaded. Only files with these extensions are allowed: {extensions}.');
            $this->addError($object,$attribute,$message,array('{file}'=>$file->getName(), '{extensions}'=>implode(', ',$types)));
        }
    }
}

Validates the attribute of the object. If there is any error, the error message is added to the object.