CUploadedFile

Подробное описание свойств

error свойство только для чтения

public integer getError()

Возвращает код ошибки, описывающий состояние загрузки этого файла.

extensionName свойство только для чтения

public string getExtensionName()

Имя расширения файла для name. Имя расширения не включает символ точки. Возвращается пустая строка, если у name нет имени расширения.

hasError свойство только для чтения

public boolean getHasError()

Указывает, есть ли ошибка с загруженным файлом. Проверьте error для получения подробной информации об коде ошибки.

name свойство только для чтения

public string getName()

Исходное имя загружаемого файла

size свойство только для чтения

public integer getSize()

Фактический размер загруженного файла в байтах

tempName свойство только для чтения

public string getTempName()

Путь к загруженному файлу на сервере. Обратите внимание, что это временный файл, который будет автоматически удалён PHP после обработки текущего запроса.

type свойство только для чтения

public string getType()

MIME-тип загруженного файла (например, "image/gif"). Поскольку этот MIME-тип не проверяется на стороне сервера, не полагайтесь на это значение. Вместо этого используйте CFileHelper::getMimeType для определения точного MIME-типа.

Подробное описание методов

__construct() метод

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;
}

Конструктор. Используйте getInstance для получения экземпляра загруженного файла.

__toString() метод

public string __toString()

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

Вывод в строковом формате. Это магический метод PHP, который возвращает строковое представление объекта. Здесь реализация возвращает имя загруженного файла.

collectFilesRecursive() метод

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);
}

Обрабатывает входящие файлы для getInstanceByName.

getError() метод

public integer getError()

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

Возвращает код ошибки, описывающий состояние загрузки этого файла.

getExtensionName() метод

public string getExtensionName()

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

getHasError() метод

public boolean getHasError()

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

getInstance() метод

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

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

Возвращает экземпляр указанного загруженного файла. Файл должен быть загружен с помощью CHtml::activeFileField.

getInstanceByName() метод

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;
}

Возвращает экземпляр указанного загруженного файла. Имя может быть обычной строкой или строкой, похожей на элемент массива (например, 'Post[imageFile]', или 'Post[0][imageFile]').

getInstances() метод

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

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

Возвращает все загруженные файлы для заданного атрибута модели.

getInstancesByName() метод

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;
}

Возвращает массив экземпляров, начиная с указанного имени массива.

Если было загружено и сохранено несколько файлов как 'Files[0]', 'Files[1]', 'Files[n]'..., вы можете получить их все, передав 'Files' в качестве имени массива.

getName() метод

public string getName()

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

getSize() метод

public integer getSize()

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

getTempName() метод

public string getTempName()

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

getType() метод

public string getType()

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

prefetchFiles() метод

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']);
}

Изначально обрабатывает суперглобальную переменную $_FILES для более удобного использования. Только для внутреннего использования.

reset() метод (доступен с версии 1.1.4)

public static void reset()

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

Очищает загруженные экземпляры CUploadedFile. Этот метод в основном используется скриптами тестов для подготовки фикстуры.

saveAs() метод

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;
}

Сохраняет загруженный файл. Примечание: этот метод использует метод move_uploaded_file() php. Таким образом, если целевой файл ($file) уже существует, он перезаписывается.