PHP Класс MongoGridFS

Наследование: extends MongoCollection
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$chunks MongoCollection

Защищенные свойства (Protected)

Свойство Тип Описание
$chunksName string
$filesName string

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

Метод Описание
__construct ( MongoDB $db, string $prefix = "fs", mixed $chunks = null ) Files as stored across two collections, the first containing file meta information, the second containing chunks of the actual file. By default, fs.files and fs.chunks are the collection names used.
__sleep ( ) : array
delete ( mixed $id ) : boolean Delete a file from the database
drop ( ) : array Drops the files and chunks collections
find ( array $query = [], array $fields = [] ) : MongoGridFSCursor
findOne ( mixed $query = [], array $fields = [], array $options = [] ) : MongoGridFSFile | null Returns a single file matching the criteria
get ( mixed $id ) : MongoGridFSFile | null Retrieve a file from the database
put ( string $filename, array $extra = [], array $options = [] ) : mixed Stores a file in the database
remove ( array $criteria = [], array $options = [] ) : boolean Removes files from the collections
storeBytes ( string $bytes, array $extra = [], array $options = [] ) : mixed Chunkifies and stores bytes in the database
storeFile ( string $filename, array $extra = [], array $options = [] ) : mixed Stores a file in the database
storeUpload ( string $name, array $metadata = [] ) : mixed Saves an uploaded file directly from a POST to the database

Приватные методы

Метод Описание
createChunksIndex ( ) Creates the index on the chunks collection
insertChunk ( mixed $fileId, string $data, integer $chunkNumber ) : array | boolean Inserts a single chunk into the database
insertChunksFromBytes ( string $bytes, array $record ) Splits a string into chunks and writes them to the database
insertChunksFromFile ( resource $handle, array $record, string &$md5 ) : integer Reads chunks from a file and writes them to the database
insertFile ( $record, array $options = [] ) : array Writes a file record to the database
isOKResult ( $result )

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

__construct() публичный Метод

Files as stored across two collections, the first containing file meta information, the second containing chunks of the actual file. By default, fs.files and fs.chunks are the collection names used.
См. ссылку: http://php.net/manual/en/mongogridfs.construct.php
public __construct ( MongoDB $db, string $prefix = "fs", mixed $chunks = null )
$db MongoDB Database
$prefix string [optional]

Optional collection name prefix.
$chunks mixed [optional]

__sleep() публичный Метод

public __sleep ( ) : array
Результат array

delete() публичный Метод

Delete a file from the database
См. ссылку: http://php.net/manual/en/mongogridfs.delete.php
public delete ( mixed $id ) : boolean
$id mixed _id of the file to remove
Результат boolean Returns true if the remove was successfully sent to the database.

drop() публичный Метод

Drops the files and chunks collections
См. ссылку: http://php.net/manual/en/mongogridfs.drop.php
public drop ( ) : array
Результат array The database response

find() публичный Метод

См. ссылку: http://php.net/manual/en/mongogridfs.find.php
public find ( array $query = [], array $fields = [] ) : MongoGridFSCursor
$query array The query
$fields array Fields to return
Результат MongoGridFSCursor A MongoGridFSCursor

findOne() публичный Метод

Returns a single file matching the criteria
См. ссылку: http://www.php.net/manual/en/mongogridfs.findone.php
public findOne ( mixed $query = [], array $fields = [], array $options = [] ) : MongoGridFSFile | null
$query mixed The fields for which to search or a filename to search for.
$fields array Fields of the results to return.
$options array Options for the find command
Результат MongoGridFSFile | null

get() публичный Метод

Retrieve a file from the database
См. ссылку: http://www.php.net/manual/en/mongogridfs.get.php
public get ( mixed $id ) : MongoGridFSFile | null
$id mixed _id of the file to find.
Результат MongoGridFSFile | null

put() публичный Метод

Stores a file in the database
См. ссылку: http://php.net/manual/en/mongogridfs.put.php
public put ( string $filename, array $extra = [], array $options = [] ) : mixed
$filename string The name of the file
$extra array Other metadata to add to the file saved
$options array An array of options for the insert operations executed against the chunks and files collections.
Результат mixed Returns the _id of the saved object

remove() публичный Метод

Removes files from the collections
См. ссылку: http://www.php.net/manual/en/mongogridfs.remove.php
public remove ( array $criteria = [], array $options = [] ) : boolean
$criteria array Description of records to remove.
$options array Options for remove.
Результат boolean

storeBytes() публичный Метод

Chunkifies and stores bytes in the database
См. ссылку: http://php.net/manual/en/mongogridfs.storebytes.php
public storeBytes ( string $bytes, array $extra = [], array $options = [] ) : mixed
$bytes string A string of bytes to store
$extra array Other metadata to add to the file saved
$options array Options for the store. "safe": Check that this store succeeded
Результат mixed The _id of the object saved

storeFile() публичный Метод

Stores a file in the database
См. ссылку: http://php.net/manual/en/mongogridfs.storefile.php
public storeFile ( string $filename, array $extra = [], array $options = [] ) : mixed
$filename string The name of the file
$extra array Other metadata to add to the file saved
$options array Options for the store. "safe": Check that this store succeeded
Результат mixed Returns the _id of the saved object

storeUpload() публичный Метод

Saves an uploaded file directly from a POST to the database
См. ссылку: http://www.php.net/manual/en/mongogridfs.storeupload.php
public storeUpload ( string $name, array $metadata = [] ) : mixed
$name string The name attribute of the uploaded file, from .
$metadata array An array of extra fields for the uploaded file.
Результат mixed Returns the _id of the uploaded file.

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

$chunks публичное свойство

MongoCollection
См. ссылку: http://php.net/manual/en/class.mongogridfs.php#mongogridfs.props.chunks
public $chunks

$chunksName защищенное свойство

string
См. ссылку: http://php.net/manual/en/class.mongogridfs.php#mongogridfs.props.chunksname
protected $chunksName

$filesName защищенное свойство

string
См. ссылку: http://php.net/manual/en/class.mongogridfs.php#mongogridfs.props.filesname
protected $filesName