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

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

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

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

Объект Download обычно создаётся вызовом yii\mongodb\file\Collection::get() или yii\mongodb\file\Collection::createDownload().

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

Yii::$app->mongodb->getFileCollection()->createDownload($document['_id'])->toFile('/path/to/file.dat');

Вы можете использовать Download::substr() для чтения определённой части файла:

$filePart = Yii::$app->mongodb->getFileCollection()->createDownload($document['_id'])->substr(256, 1024);

Открытые свойства

Свойство	Тип	Описание	Определено в
$bytes	string	Содержимое файла.	yii\mongodb\file\Download
$chunkCursor	\MongoDB\Driver\Cursor	Курсор списка фрагментов.	yii\mongodb\file\Download
$chunkIterator	Iterator	Итератор курсора фрагментов.	yii\mongodb\file\Download
$collection	yii\mongodb\file\Collection	Коллекция файлов для использования.	yii\mongodb\file\Download
$document	array	Документ для загрузки.	yii\mongodb\file\Download
$filename	string\|null	Имя файла.	yii\mongodb\file\Download
$resource	resource	Ресурс потока файла.	yii\mongodb\file\Download
$size	integer	Размер файла.	yii\mongodb\file\Download

Открытые методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Object
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства объекта.	yii\base\Object
__isset()	Проверяет, установлено ли свойство, т. е. определено и не равно null.	yii\base\Object
__set()	Устанавливает значение свойства объекта.	yii\base\Object
__unset()	Устанавливает свойство объекта в null.	yii\base\Object
canGetProperty()	Возвращает значение, указывающее, можно ли прочитать свойство.	yii\base\Object
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Object
className()	Возвращает полное имя этого класса.	yii\base\Object
getBytes()	Псевдоним метода toString().	yii\mongodb\file\Download
getChunkCursor()	Возвращает курсор для чтения фрагментов файла.	yii\mongodb\file\Download
getChunkIterator()	Возвращает итератор для курсора фрагментов файла.	yii\mongodb\file\Download
getDocument()		yii\mongodb\file\Download
getFilename()	Возвращает имя файла.	yii\mongodb\file\Download
getResource()	Возвращает постоянный ресурс потока, который можно использовать для чтения файла.	yii\mongodb\file\Download
getSize()	Возвращает размер связанного файла.	yii\mongodb\file\Download
hasMethod()	Возвращает значение, указывающее, определён ли метод.	yii\base\Object
hasProperty()	Возвращает значение, указывающее, определено ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\base\Object
setDocument()	Устанавливает данные документа для загрузки.	yii\mongodb\file\Download
substr()	Возвращает часть файла.	yii\mongodb\file\Download
toFile()	Сохраняет загрузку в физический файл.	yii\mongodb\file\Download
toResource()	Возвращает открытый ресурс потока, который можно использовать для чтения файла.	yii\mongodb\file\Download
toStream()	Сохраняет файл в указанный поток.	yii\mongodb\file\Download
toString()	Возвращает строку байтов в связанном файле.	yii\mongodb\file\Download
write()	Псевдоним метода toFile().	yii\mongodb\file\Download

Подробности свойств

$bytes public только для чтения свойство

Содержимое файла.

public string getBytes ( )

$chunkCursor public только для чтения свойство

Курсор списка фрагментов.

public \MongoDB\Driver\Cursor getChunkCursor ( $refresh = false )

$chunkIterator public только для чтения свойство

Итератор курсора фрагментов.

public Iterator getChunkIterator ( $refresh = false )

$collection public свойство

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

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

$document public свойство

Документ для загрузки.

public array getDocument ( )
public void setDocument ( $document )

$filename public только для чтения свойство

Имя файла.

public string|null getFilename ( )

$resource public только для чтения свойство

Ресурс потока файла.

public resource getResource ( )

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

Размер файла.

public integer getSize ( )

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

getBytes() public method

Псевдоним метода toString().

public string getBytes ( )
return	string	Содержимое файла.

getChunkCursor() public method

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

public \MongoDB\Driver\Cursor getChunkCursor ( $refresh = false )
$refresh	boolean	Пересоздать курсор, если он уже существует.
return	\MongoDB\Driver\Cursor	Курсор списка фрагментов.
throws	yii\base\InvalidConfigException

getChunkIterator() public method

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

public Iterator getChunkIterator ( $refresh = false )
$refresh	boolean	Пересоздать итератор, если он уже существует.
return	Iterator	Итератор курсора фрагментов.

getDocument() public method

public array getDocument ( )
return	array	Документ для загрузки.
throws	yii\base\InvalidConfigException	при неверной конфигурации документа.

getFilename() public method

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

public string\|null getFilename ( )
return	string\|null	Имя файла.

getResource() public method

Возвращает постоянный ресурс потока, который можно использовать для чтения файла.

public resource getResource ( )
return	resource	Ресурс потока файла.

getSize() public method

Возвращает размер связанного файла.

public integer getSize ( )
return	integer	Размер файла.

setDocument() public method

Устанавливает данные документа для загрузки.

Документ может быть указан по его ID, в этом случае его данные будут извлечены автоматически с помощью дополнительного запроса.

public void setDocument ( $document )
$document	array\|\MongoDB\BSON\ObjectID	Исходные данные документа или ID документа.

substr() public method

Возвращает часть файла.

public string\|false substr ( $start, $length )
$start	integer	Начальная позиция чтения. Если неотрицательная, возвращаемая строка начнётся с позиции start в файле, считая с нуля. Если отрицательная, возвращаемая строка начнётся с start-го символа с конца файла.
$length	integer	Количество байтов для чтения. Если положительная, возвращаемая строка будет содержать не более length символов, начиная с позиции start (в зависимости от длины файла). Если отрицательная, столько символов будет опущено с конца файла (после вычисления начальной позиции, если start отрицательный).
return	string\|false	Извлечённая часть файла или `false` при ошибке.

toFile() public method

Сохраняет загрузку в физический файл.

public integer toFile ( $filename )
$filename	string	Имя физического файла.
return	integer	Количество записанных байтов.

toResource() public method

Возвращает открытый ресурс потока, который можно использовать для чтения файла.

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

public resource toResource ( )
return	resource	Ресурс потока.

toStream() public method

Сохраняет файл в указанный поток.

public integer toStream ( $stream )
$stream	resource	Поток, в который следует сохранить файл.
return	integer	Количество записанных байтов.

toString() public method

Возвращает строку байтов в связанном файле.

public string toString ( )
return	string	Содержимое файла.

write() public method

Псевдоним метода toFile().

public integer write ( $filename )
$filename	string	Имя физического файла.
return	integer	Количество записанных байтов.

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