CUploadedFile

所有包 | 属性 | 方法

包	system.web
继承	class CUploadedFile » CComponent
可用自	1.0
版本	$Id$

CUploadedFile represents the information for an uploaded file.

Call getInstance to retrieve the instance of an uploaded file, and then use saveAs to save it on the server. You may also query other information about the file, including name, tempName, type, size and error.

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
error	integer	Returns an error code describing the status of this file uploading.	CUploadedFile
extensionName	string	the file extension name for name.	CUploadedFile
hasError	boolean	whether there is an error with the uploaded file.	CUploadedFile
name	string	the original name of the file being uploaded	CUploadedFile
size	integer	the actual size of the uploaded file in bytes	CUploadedFile
tempName	string	the path of the uploaded file on the server.	CUploadedFile
type	string	the MIME-type of the uploaded file (such as "image/gif").	CUploadedFile

公共方法

隐藏继承的方法

方法	描述	被定义在
__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
__toString()	String output.	CUploadedFile
__unset()	Sets a component property to be null.	CComponent
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
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
getError()	Returns an error code describing the status of this file uploading.	CUploadedFile
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getExtensionName()		CUploadedFile
getHasError()		CUploadedFile
getInstance()	Returns an instance of the specified uploaded file.	CUploadedFile
getInstanceByName()	Returns an instance of the specified uploaded file.	CUploadedFile
getName()		CUploadedFile
getSize()		CUploadedFile
getTempName()		CUploadedFile
getType()		CUploadedFile
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
saveAs()	Saves the uploaded file.	CUploadedFile

受保护的方法

隐藏继承的方法

方法	描述	被定义在
__construct()	Constructor.	CUploadedFile

属性详情

error 属性只读

public integer getError()

Returns an error code describing the status of this file uploading.

参见

http://www.php.net/manual/en/features.file-upload.errors.php

extensionName 属性只读

public string getExtensionName()

the file extension name for name. The extension name does not include the dot character. An empty string is returned if name does not have an extension name.

hasError 属性只读

public boolean getHasError()

whether there is an error with the uploaded file. Check error for detailed error code information.

name 属性只读

public string getName()

the original name of the file being uploaded

size 属性只读

public integer getSize()

the actual size of the uploaded file in bytes

tempName 属性只读

public string getTempName()

the path of the uploaded file on the server. Note, this is a temporary file which will be automatically deleted by PHP after the current request is processed.

type 属性只读

public string getType()

the MIME-type of the uploaded file (such as "image/gif"). Since this MIME type is not checked on the server side, do not take this value for granted. Instead, use CFileHelper::getMimeType to determine the exact MIME type.

方法详情

__construct() 方法

protected void __construct(string $name, string $tempName, string $type, integer $size, integer $error)
$name	string	the original name of the file being uploaded
$tempName	string	the path of the uploaded file on the server.
$type	string	the MIME-type of the uploaded file (such as "image/gif").
$size	integer	the actual size of the uploaded file in bytes
$error	integer	the error code

Constructor. Use getInstance to get an instance of an uploaded file.

__toString() 方法（自版本 v1.0.2 可用）

public string __toString()
{return}	string	the string representation of the object

String output. This is PHP magic method that returns string representation of an object. The implementation here returns the uploaded file's name.

getError() 方法

public integer getError()
{return}	integer	the error code

Returns an error code describing the status of this file uploading.

参见

http://www.php.net/manual/en/features.file-upload.errors.php

getExtensionName() 方法

public string getExtensionName()
{return}	string	the file extension name for name. The extension name does not include the dot character. An empty string is returned if name does not have an extension name.

getHasError() 方法

public boolean getHasError()
{return}	boolean	whether there is an error with the uploaded file. Check error for detailed error code information.

getInstance() 方法

public static CUploadedFile getInstance(CModel $model, string $attribute)
$model	CModel	the model instance
$attribute	string	the attribute name. For tabular file uploading, this can be in the format of "attributeName[$i]", where $i stands for an integer index.
{return}	CUploadedFile	the instance of the uploaded file. Null is returned if no file is uploaded for the specified model attribute.

Returns an instance of the specified uploaded file. The file should be uploaded using CHtml::activeFileField.

参见

getInstanceByName

getInstanceByName() 方法

public static CUploadedFile getInstanceByName(string $name)
$name	string	the name of the file input field.
{return}	CUploadedFile	the instance of the uploaded file. Null is returned if no file is uploaded for the specified name.

Returns an instance of the specified uploaded file. The name can be a plain string or a string like an array element (e.g. 'Post[imageFile]', or 'Post[0][imageFile]').

getName() 方法

public string getName()
{return}	string	the original name of the file being uploaded

getSize() 方法

public integer getSize()
{return}	integer	the actual size of the uploaded file in bytes

getTempName() 方法

public string getTempName()
{return}	string	the path of the uploaded file on the server. Note, this is a temporary file which will be automatically deleted by PHP after the current request is processed.

getType() 方法

public string getType()
{return}	string	the MIME-type of the uploaded file (such as "image/gif"). Since this MIME type is not checked on the server side, do not take this value for granted. Instead, use CFileHelper::getMimeType to determine the exact MIME type.

saveAs() 方法

public boolean saveAs(string $file, boolean $deleteTempFile=true)
$file	string	the file path used to save the uploaded file
$deleteTempFile	boolean	whether to delete the temporary file after saving. If true, you will not be able to save the uploaded file again in the current request.
{return}	boolean	true whether the file is saved successfully

Saves the uploaded file.