Класс yii\mongodb\file\Upload

Все классы | Свойства | Методы

Наследование	yii\mongodb\file\Upload » yii\base\Object
Реализует	yii\base\Configurable
Доступна с версии	2.1
Исходный код	https://github.com/yiisoft/yii2-mongodb/blob/master/file/Upload.php

Upload представляет операцию загрузки GridFS.

Объект Upload обычно создаётся вызовом yii\mongodb\file\Collection::createUpload().

Примечание: экземпляр этого класса предназначен только для однократного использования. Не пытайтесь использовать один и тот же экземпляр Upload для многократной загрузки файлов.

Пример использования:

$document = Yii::$app->mongodb->getFileCollection()->createUpload()
    ->addContent('Part 1')
    ->addContent('Part 2')
    // ...
    ->complete();

Общедоступные свойства

Свойство	Тип	Описание	Определено в
$chunkCount	integer	Количество фрагментов файла.	yii\mongodb\file\Upload
$chunkSize	integer	Размер фрагмента в байтах.	yii\mongodb\file\Upload
$collection	yii\mongodb\file\Collection	Коллекция файлов для использования.	yii\mongodb\file\Upload
$document	array	Дополнительные данные файла.	yii\mongodb\file\Upload
$filename	string	Имя файла для хранения.	yii\mongodb\file\Upload
$length	integer	Общий размер загрузки в байтах.	yii\mongodb\file\Upload

Общедоступные методы

Метод	Описание	Определено в
__call()	Вызывает метод, который не является методом класса.	yii\base\Object
__construct()	Конструктор.	yii\base\Object
__destruct()	Деструктор.	yii\mongodb\file\Upload
__get()	Возвращает значение свойства объекта.	yii\base\Object
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Object
__set()	Устанавливает значение свойства объекта.	yii\base\Object
__unset()	Устанавливает свойство объекта в null.	yii\base\Object
addContent()	Добавляет строковое содержимое к загрузке.	yii\mongodb\file\Upload
addFile()	Добавляет содержимое файла к загрузке.	yii\mongodb\file\Upload
addStream()	Добавляет содержимое потока к загрузке.	yii\mongodb\file\Upload
canGetProperty()	Возвращает значение, указывающее, можно ли прочитать свойство.	yii\base\Object
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Object
cancel()	Отменяет загрузку.	yii\mongodb\file\Upload
className()	Возвращает полное имя класса.	yii\base\Object
complete()	Завершает загрузку.	yii\mongodb\file\Upload
hasMethod()	Возвращает значение, указывающее, определён ли метод.	yii\base\Object
hasProperty()	Возвращает значение, указывающее, определено ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\mongodb\file\Upload

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

$chunkCount общедоступное свойство

Количество фрагментов файла.

public integer $chunkCount = 0

$chunkSize общедоступное свойство

Размер фрагмента в байтах.

public integer $chunkSize = 261120

$collection общедоступное свойство

Коллекция файлов для использования.

public yii\mongodb\file\Collection $collection = null

$document общедоступное свойство

Дополнительные данные файла. Общие колонки GridFS:

metadata: массив, дополнительные данные, связанные с файлом.
aliases: массив, массив псевдонимов.
contentType: строка, тип содержимого для хранения с файлом.

public array $document = []

$filename общедоступное свойство

Имя файла для хранения.

public string $filename = null

$length общедоступное свойство

Общий размер загрузки в байтах.

public integer $length = 0

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

__destruct() public method

Деструктор.

Убеждается, что отменён отказ от загрузки.

public void __destruct ( )

addContent() public method

Добавляет строковое содержимое в загрузку.

Этот метод можно вызывать несколько раз до вызова complete().

public $this addContent ( $content )
$content	string	Двоичное содержимое.
return	$this	Ссылка на себя.

addFile() public method

Добавляет содержимое файла в загрузку.

Этот метод можно вызывать несколько раз до вызова complete().

public $this addFile ( $filename )
$filename	string	Имя исходного файла.
return	$this	Ссылка на себя.

addStream() public method

Добавляет содержимое потока в загрузку.

Этот метод можно вызывать несколько раз до вызова complete().

public $this addStream ( $stream )
$stream	resource	Поток источника данных.
return	$this	Ссылка на себя.

cancel() public method

Отменяет загрузку.

public void cancel ( )

complete() public method

Завершает загрузку.

public array complete ( )
return	array	Сохранённый документ.

init() public method

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта с заданной конфигурацией.

public void init ( )

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mongodb-file-upload.html