CFileValidator
| 包 | system.validators |
|---|---|
| 继承 | class CFileValidator » CValidator » CComponent |
| 可用自 | 1.0 |
| 版本 | $Id$ |
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.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| 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 |
受保护的属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| sizeLimit | integer | Returns the maximum size allowed for uploaded files. | CFileValidator |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __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 |
受保护的方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| 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 |
属性详情
whether the attribute requires a file to be uploaded or not. Defaults to false, meaning a file is required to be 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' INI setting and the 'MAX_FILE_SIZE' hidden field value.
参见
the minimum number of bytes required for the uploaded file. Defaults to null, meaning no 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
the error message used when the uploaded file is too large.
参见
the error message used when the uploaded file is too small.
参见
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.
the error message used when the uploaded file has an extension name that is not listed among extensions.
方法详情
|
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
|
protected void validateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | the object being validated |
| $attribute | string | the attribute being validated |
Validates the attribute of the object. If there is any error, the error message is added to the object.