• Главная
• yii
• mongodb
• file
• Download

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

A Download object is usually created by calling [[Collection::get()]] or [[Collection::createDownload()]]. Usage example: php Yii::$app->mongodb->getFileCollection()->createDownload($document['_id'])->toFile('/path/to/file.dat'); You can use Download::substr() to read a specific part of the file: php $filePart = Yii::$app->mongodb->getFileCollection()->createDownload($document['_id'])->substr(256, 1024); Показать файл Открыть проект Примеры использования класса

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

Свойство	Тип	Описание
$collection		file collection to be used.

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

Метод	Описание
getBytes ( ) : string	Alias of Download::toString method.
getChunkCursor ( boolean $refresh = false ) : MongoDB\Driver\Cursor	Returns file chunks read cursor.
getChunkIterator ( boolean $refresh = false ) : Iterator	Returns iterator for the file chunks cursor.
getDocument ( ) : array
getFilename ( ) : string | null	Returns associated file's filename.
getResource ( ) : resource	Returns persistent stream resource, which can be used to read file.
getSize ( ) : integer	Returns the size of the associated file.
setDocument ( array | MongoDB\BSON\ObjectID $document )	Sets data of the document to be downloaded.
substr ( integer $start, integer $length ) : string | false	Return part of a file.
toFile ( string $filename ) : integer	Saves download to the physical file.
toResource ( ) : resource	Returns an opened stream resource, which can be used to read file.
toStream ( resource $stream ) : integer	Saves file into the given stream.
toString ( ) : string	Returns a string of the bytes in the associated file.
write ( string $filename ) : integer	Alias of Download::toFile method.

Описание методов

Описание свойств