Home » Documentation » Class Reference » CFileValidator

CFileValidator

Package	system.validators
Inheritance	class CFileValidator » CValidator » CComponent
Since	1.0
Version	$Id: CFileValidator.php 2025 2010-04-07 11:50:00Z alexander.makarow $

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.

This validator will attempt to fetch uploaded data if attribute is not previously set. Please note that this cannot be done if input is tabular:

 foreach($models as $i=>$model)
    $model->attribute = CUploadedFile::getInstance($model, "[$i]attribute");

Please note that you must use {link CUploadedFile::getInstances} for multiple file uploads.

When using CFileValidator with an active record, the following code is often used:

 if($model->save())
 {
    // single upload
    $model->attribute->saveAs($path);
    // multiple upload
    foreach($model->attribute as $file)
       $file->saveAs($path);
 }

You can use CFileValidator to validate the file attribute.

Public Properties

Hide inherited properties

Property	Type	Description	Defined 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
maxFiles	integer	the maximum file count the given attribute can hold.	CFileValidator
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
skipOnError	boolean	whether this validation rule should be skipped if when there is already a validation error for the current attribute.	CValidator
tooLarge	string	the error message used when the uploaded file is too large.	CFileValidator
tooMany	string	the error message used if the count of multiple uploads exceeds limit.	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

Property	Type	Description	Defined By
sizeLimit	integer	Returns the maximum size allowed for uploaded files.	CFileValidator

Public Methods

Hide inherited methods

Method	Description	Defined 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
evaluateExpression()	Evaluates a PHP expression or callback under the context of 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

Method	Description	Defined By
addError()	Adds an error about the specified attribute to the active record.	CValidator
emptyAttribute()	Raises an error to inform end user about blank attribute.	CFileValidator
getSizeLimit()	Returns the maximum size allowed for uploaded files.	CFileValidator
isEmpty()	Checks if the given value is empty.	CValidator
validateAttribute()	Set the attribute and then validates using validateFile.	CFileValidator
validateFile()	Internally validates a file 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.

maxFiles property

public integer $maxFiles;

the maximum file count the given attribute can hold. It defaults to 1, meaning single file upload. By defining a higher number, multiple uploads become possible.

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.

Method Details

emptyAttribute() method

protected void emptyAttribute(CModel $object, string $attribute)
$object	CModel	the object being validated
$attribute	string	the attribute being validated

Raises an error to inform end user about blank attribute.

getSizeLimit() method

protected integer getSizeLimit()
{return}	integer	the size limit for uploaded files.

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

Set the attribute and then validates using validateFile. If there is any error, the error message is added to the object.

validateFile() method

protected void validateFile(CModel $object, string $attribute, CUploadedFile $file)
$object	CModel	the object being validated
$attribute	string	the attribute being validated
$file	CUploadedFile	uploaded file passed to check against a set of rules

Internally validates a file object.

Total 1 comment:

#1285

Validating files...

by mech7 at 3:25pm on March 16, 2010.

Mostly file will only need to be validated on insert not update.. it can be achieved with the following example:

public function rules() { // NOTE: you should only define rules for those attributes that // will receive user inputs. return array( array('title', 'required'), array('title', 'length', 'max'=>125), array('description', 'safe'), array('pdf', 'file','on'=>'insert', 'types'=> 'pdf', 'maxSize' => 1024 * 1024 * 10, // 10MB
'tooLarge' => 'The file was larger than 10MB. Please upload a smaller file.',
), array('pdf', 'file','on'=>'update', 'allowEmpty' => true, 'types'=> 'pdf', 'maxSize' => 1024 * 1024 * 10, // 10MB
'tooLarge' => 'The file was larger than 10MB. Please upload a smaller file.',
), ); }

With help from steffo.dietz :)

CFileValidator

Public Properties

Protected Properties

Public Methods

Protected Methods

Property Details

See Also

See Also

See Also

See Also

Method Details

Total 1 comment:

Your Comment: