PHP Class MongoGridFSFile

Author: Johannes Skov Frandsen ([email protected])

Show file Open project: alcaeus/mongo-php-adapter Class Usage Examples

Public Properties

Property	Type	Description
$file	array

Protected Properties

Property	Type	Description
$gridfs

Public Methods

Method	Description
__construct ( MongoGridFS $gridfs, array $file )
getBytes ( ) : string	This will load the file into memory. If the file is bigger than your memory, this will cause problems!
getFilename ( ) : string	Returns this file's filename
getResource ( ) : resource	This method returns a stream resource that can be used to read the stored file with all file functions in PHP.
getSize ( ) : integer	Returns this file's size
write ( string $filename = null ) : integer	Writes this file to the filesystem

Private Methods

Method	Description
copyToResource ( $handle )
getChunks ( )

Method Details

__construct() public method

See link: http://php.net/manual/en/mongogridfsfile.construct.php

public __construct ( MongoGridFS $gridfs, array $file )
$gridfs	MongoGridFS	The parent MongoGridFS instance
$file	array	A file from the database

getBytes() public method

This will load the file into memory. If the file is bigger than your memory, this will cause problems!

See link: http://php.net/manual/en/mongogridfsfile.getbytes.php

public getBytes ( ) : string
return	string	Returns a string of the bytes in the file

getFilename() public method

Returns this file's filename

See link: http://php.net/manual/en/mongogridfsfile.getfilename.php

public getFilename ( ) : string
return	string	Returns the filename

getResource() public method

The contents of the file are pulled out of MongoDB on the fly, so that the whole file does not have to be loaded into memory first. At most two GridFSFile chunks will be loaded in memory.

See link: http://php.net/manual/en/mongogridfsfile.getresource.php

public getResource ( ) : resource
return	resource	Returns a resource that can be used to read the file with

getSize() public method

Returns this file's size

See link: http://php.net/manual/en/mongogridfsfile.getsize.php

public getSize ( ) : integer
return	integer	Returns this file's size

write() public method

Writes this file to the filesystem

See link: http://php.net/manual/en/mongogridfsfile.write.php

public write ( string $filename = null ) : integer
$filename	string	The location to which to write the file (path+filename+extension). If none is given, the stored filename will be used.
return	integer	Returns the number of bytes written

Property Details

$file public property

See link: http://php.net/manual/en/class.mongogridfsfile.php#mongogridfsfile.props.file

public array $file
return	array

$gridfs protected property

See link: http://php.net/manual/en/class.mongogridfsfile.php#mongogridfsfile.props.gridfs

protected $gridfs