CUploadedFile

Property Details

error property read-only

public integer getError()

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

extensionName property read-only

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 property read-only

public boolean getHasError()

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

name property read-only

public string getName()

the original name of the file being uploaded

size property read-only

public integer getSize()

the actual size of the uploaded file in bytes

tempName property read-only

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 property read-only

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.

Method Details

__construct() method

public void __construct(string $name, string $tempName, string $type, integer $size, integer $error)

public function __construct($name,$tempName,$type,$size,$error)
{
    $this->_name=$name;
    $this->_tempName=$tempName;
    $this->_type=$type;
    $this->_size=$size;
    $this->_error=$error;
}

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

__toString() method

public string __toString()

public function __toString()
{
    return $this->_name;
}

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

collectFilesRecursive() method

protected static void collectFilesRecursive(string $key, mixed $names, mixed $tmp_names, mixed $types, mixed $sizes, mixed $errors)

protected static function collectFilesRecursive($key, $names, $tmp_names, $types, $sizes, $errors)
{
    if(is_array($names))
    {
        foreach($names as $item=>$name)
            self::collectFilesRecursive($key.'['.$item.']', $names[$item], $tmp_names[$item], $types[$item], $sizes[$item], $errors[$item]);
    }
    else
        self::$_files[$key] = new CUploadedFile($names, $tmp_names, $types, $sizes, $errors);
}

Processes incoming files for getInstanceByName.

getError() method

public integer getError()

public function getError()
{
    return $this->_error;
}

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

getExtensionName() method

public string getExtensionName()

public function getExtensionName()
{
    return CFileHelper::getExtension($this->_name);
}

getHasError() method

public boolean getHasError()

public function getHasError()
{
    return $this->_error!=UPLOAD_ERR_OK;
}

getInstance() method

public static CUploadedFile getInstance(CModel $model, string $attribute)

public static function getInstance($model, $attribute)
{
    return self::getInstanceByName(CHtml::resolveName($model, $attribute));
}

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

getInstanceByName() method

public static CUploadedFile getInstanceByName(string $name)

public static function getInstanceByName($name)
{
    if(null===self::$_files)
        self::prefetchFiles();

    return isset(self::$_files[$name]) && self::$_files[$name]->getError()!=UPLOAD_ERR_NO_FILE ? self::$_files[$name] : null;
}

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

getInstances() method

public static CUploadedFile[] getInstances(CModel $model, string $attribute)

public static function getInstances($model, $attribute)
{
    return self::getInstancesByName(CHtml::resolveName($model, $attribute));
}

Returns all uploaded files for the given model attribute.

getInstancesByName() method

public static CUploadedFile[] getInstancesByName(string $name)

public static function getInstancesByName($name)
{
    if(null===self::$_files)
        self::prefetchFiles();

    $len=strlen($name);
    $results=array();
    foreach(array_keys(self::$_files) as $key)
        if(0===strncmp($key, $name.'[', $len+1) && self::$_files[$key]->getError()!=UPLOAD_ERR_NO_FILE)
            $results[] = self::$_files[$key];
    return $results;
}

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.

getName() method

public string getName()

public function getName()
{
    return $this->_name;
}

getSize() method

public integer getSize()

public function getSize()
{
    return $this->_size;
}

getTempName() method

public string getTempName()

public function getTempName()
{
    return $this->_tempName;
}

getType() method

public string getType()

public function getType()
{
    return $this->_type;
}

prefetchFiles() method

protected static void prefetchFiles()

protected static function prefetchFiles()
{
    self::$_files = array();
    if(!isset($_FILES) || !is_array($_FILES))
        return;

    foreach($_FILES as $class=>$info)
        self::collectFilesRecursive($class, $info['name'], $info['tmp_name'], $info['type'], $info['size'], $info['error']);
}

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

reset() method (available since v1.1.4)

public static void reset()

public static function reset()
{
    self::$_files=null;
}

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

saveAs() method

public boolean saveAs(string $file, boolean $deleteTempFile=true)

public function saveAs($file,$deleteTempFile=true)
{
    if($this->_error==UPLOAD_ERR_OK)
    {
        if($deleteTempFile)
            return move_uploaded_file($this->_tempName,$file);
        elseif(is_uploaded_file($this->_tempName))
            return copy($this->_tempName, $file);
        else
            return false;
    }
    else
        return false;
}

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.