<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Fetches toolkit for dealing with files stored in this database</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb.getdbref.html">MongoDB::getDBRef</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb.getprofilinglevel.html">MongoDB::getProfilingLevel</a></div>
<div class="up"><a href="class.mongodb.html">MongoDB</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb.getgridfs" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB::getGridFS</h1>
<p class="verinfo">(PECL mongo >=0.9.0)</p><p class="refpurpose"><span class="refname">MongoDB::getGridFS</span> — <span class="dc-title">Fetches toolkit for dealing with files stored in this database</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb.getgridfs-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.mongogridfs.html" class="type MongoGridFS">MongoGridFS</a></span> <span class="methodname"><strong>MongoDB::getGridFS</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$prefix</code><span class="initializer"> = "fs"</span></span>
] )</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb.getgridfs-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term">
<em><code class="parameter">prefix</code></em>
</span>
<dd>
<p class="para">
The prefix for the files and chunks collections.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb.getgridfs-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a new gridfs object for this database.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongodb.getgridfs-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1424">
<p><strong>Example #1 <span class="function"><strong>MongoDB::getGridFS()</strong></span> example</strong></p>
<div class="example-contents"><p>This example demonstrates how get a MongoGridFS instance.</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$db </span><span style="color: #007700">= </span><span style="color: #0000BB">$mongo</span><span style="color: #007700">-></span><span style="color: #0000BB">my_db</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$prefix </span><span style="color: #007700">= </span><span style="color: #DD0000">'files'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">getGridFS</span><span style="color: #007700">(</span><span style="color: #0000BB">$prefix</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>
Read more about the <a href="class.mongogridfs.html" class="classname">MongoGridFS</a> to learn how to store files with MongoDB.
</p></div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb.getdbref.html">MongoDB::getDBRef</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb.getprofilinglevel.html">MongoDB::getProfilingLevel</a></div>
<div class="up"><a href="class.mongodb.html">MongoDB</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
