mongogridfs.put(3) [php man page]

MONGOGRIDFS.PUT(3)							 1							MONGOGRIDFS.PUT(3)

MongoGridFS::put - Stores a file in the database

SYNOPSIS

       public mixed MongoGridFS::put (string  $filename, [array  $metadata = array()], [array  $options = array()])

DESCRIPTION

       Note

	      MongoGridFS::put is an alias of MongoGridFS::storeFile.

PARAMETERS

	      o $filename
		- Name of the file to store.

	      o $metadata
		- Other metadata fields to include in the file document.

	      Note

		     These  fields  may  also  overwrite those that would be created automatically by the driver, as described in the MongoDB core
		     documentation for the files collection. Some practical use cases for this behavior would be to specify a custom chunkSize	or
		     _id for the file.

	      o $options
		-  An  array of options for the insert operations executed against the chunks and files collections. See MongoCollection.insert(3)
		for documentation on these these options.

RETURN VALUES

       Returns the _id of the saved file document. This will be a generated MongoId unless an _id was explicitly specified in the $metadata param-
       eter.

ERRORS
/EXCEPTIONS
	Throws MongoGridFSException if there is an error reading $filename or inserting into the chunks or files collections.

SEE ALSO 
MongoGridFS.storeBytes(3), MongoGridFS.storeFile(3), MongoGridFS.storeUpload(3), MongoDB core docs on GridFS.
PHP Documentation Group 													MONGOGRIDFS.PUT(3)

MONGOGRIDFS.STOREFILE(3)						 1						  MONGOGRIDFS.STOREFILE(3)

MongoGridFS::storeFile - Stores a file in the database

SYNOPSIS

       public mixed MongoGridFS::storeFile (string|resource  $filename, [array	$metadata = array()], [array  $options = array()])

DESCRIPTION

PARAMETERS

	      o $filename
		- Name of the file or a readable stream to store.

	      o $metadata
		- Other metadata fields to include in the file document.

	      Note

		     These  fields  may  also  overwrite those that would be created automatically by the driver, as described in the MongoDB core
		     documentation for the files collection. Some practical use cases for this behavior would be to specify a custom chunkSize	or
		     _id for the file.

	      o $options
		-  An  array of options for the insert operations executed against the chunks and files collections. See MongoCollection.insert(3)
		for documentation on these these options.

RETURN VALUES

       Returns the _id of the saved file document. This will be a generated MongoId unless an _id was explicitly specified in the $metadata param-
       eter.

ERRORS
/EXCEPTIONS
	Throws MongoGridFSException if there is an error reading $filename or inserting into the chunks or files collections.

EXAMPLES

       Example #1

	      MongoGridFS.storeFile(3) with additional metadata

	      <?php
	      $m = new MongoClient();
	      $gridfs = $m->selectDB('test')->getGridFS();

	      $id = $gridfs->storeFile('example.txt', array('contentType' => 'plain/text'));
	      $gridfsFile = $gridfs->get($id);

	      var_dump($gridfsFile->file);
	      ?>

	      The above example will output something similar to:

	      array(7) {
		["_id"]=>
		object(MongoId)#6(0) {
		}
		["contentType"]=>
		string(10) "plain/text"
		["filename"]=>
		string(11) "example.txt"
		["uploadDate"]=>
		object(MongoDate)#7(0) {
		}
		["length"]=>
		int(26)
		["chunkSize"]=>
		int(262144)
		["md5"]=>
		string(32) "c3fcd3d76192e4007dfb496cca67e13b"
	      }

SEE ALSO 
MongoGridFS.put(3), MongoGridFS.storeBytes(3), MongoGridFS.storeUpload(3), MongoDB core docs on GridFS.
PHP Documentation Group 												  MONGOGRIDFS.STOREFILE(3)