CUploadedFile

Package	system.web
Inheritance	class CUploadedFile » CComponent
Since	1.0
Source Code	framework/web/CUploadedFile.php

Property Details

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

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.

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

the original name of the file being uploaded

the actual size of the uploaded file in bytes

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.

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.

Method Details

public 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.

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.

protected static void collectFilesRecursive(string $key, mixed $names, mixed $tmp_names, mixed $types, mixed $sizes, mixed $errors)
$key	string	key for identifiing uploaded file: class name and subarray indexes
$names	mixed	file names provided by PHP
$tmp_names	mixed	temporary file names provided by PHP
$types	mixed	filetypes provided by PHP
$sizes	mixed	file sizes provided by PHP
$errors	mixed	uploading issues provided by PHP

Processes incoming files for getInstanceByName.

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

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

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.

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

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 "[$i]attributeName", 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.

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]').

public static CUploadedFile[] getInstances(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 "[$i]attributeName", where $i stands for an integer index.
{return}	CUploadedFile[]	array of CUploadedFile objects. Empty array is returned if no available file was found for the given attribute.

Returns all uploaded files for the given model attribute.

public static CUploadedFile[] getInstancesByName(string $name)
$name	string	the name of the array of files
{return}	CUploadedFile[]	the array of CUploadedFile objects. Empty array is returned if no adequate upload was found. Please note that this array will contain all files from all subarrays regardless how deeply nested they are.

Returns an array of instances starting with specified array name.

If multiple files were uploaded and saved as 'Files[0]', 'Files[1]', 'Files[n]'..., you can have them all by passing 'Files' as array name.

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

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

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.

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.

protected static void prefetchFiles()

Initially processes $_FILES superglobal for easier use. Only for internal usage.

public static void reset()

Cleans up the loaded CUploadedFile instances. This method is mainly used by test scripts to set up a fixture.

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 In some exceptional cases such as not enough permissions to write to the path specified PHP warning is triggered.

Saves the uploaded file. Note: this method uses php's move_uploaded_file() method. As such, if the target file ($file) already exists it is overwritten.