<!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>The MongoGridFSFile class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongogridfs.storeupload.html">MongoGridFS::storeUpload</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongogridfsfile.construct.html">MongoGridfsFile::__construct</a></div>
<div class="up"><a href="mongo.gridfs.html">GridFS Classes</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mongogridfsfile" class="reference">
<h1 class="title">The MongoGridFSFile class</h1>
<div class="partintro"><p class="verinfo">(PECL mongo >=0.9.0)</p>
<div class="section" id="mongogridfsfile.intro">
<h2 class="title">Introduction</h2>
<p class="para">
A database file object.
</p>
</div>
<div class="section" id="mongogridfsfile.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">MongoGridFSFile</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Fields */</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<span class="type">array</span>
<var class="varname">$<var class="varname">file</var></var>
<span class="initializer"> = <strong><code>NULL</code></strong></span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<span class="type"><a href="class.mongogridfs.html" class="type MongoGridFS">MongoGridFS</a></span>
<var class="varname">$<var class="varname">gridfs</var></var>
<span class="initializer"> = <strong><code>NULL</code></strong></span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="mongogridfsfile.construct.html" class="methodname">MongoGridfsFile::__construct</a></span>
( <span class="methodparam"><span class="type"><a href="class.mongogridfs.html" class="type MongoGridFS">MongoGridFS</a></span> <code class="parameter">$gridfs</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$file</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongogridfsfile.getbytes.html" class="methodname">getBytes</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongogridfsfile.getfilename.html" class="methodname">getFilename</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">stream</span> <span class="methodname"><a href="mongogridfsfile.getresource.html" class="methodname">getResource</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="mongogridfsfile.getsize.html" class="methodname">getSize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="mongogridfsfile.write.html" class="methodname">write</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
] )</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongogridfsfile.construct.html">MongoGridfsFile::__construct</a> — Create a new GridFS file</li><li><a href="mongogridfsfile.getbytes.html">MongoGridFSFile::getBytes</a> — Returns this file's contents as a string of bytes</li><li><a href="mongogridfsfile.getfilename.html">MongoGridFSFile::getFilename</a> — Returns this file's filename</li><li><a href="mongogridfsfile.getresource.html">MongoGridFSFile::getResource</a> — Returns a resource that can be used to read the stored file</li><li><a href="mongogridfsfile.getsize.html">MongoGridFSFile::getSize</a> — Returns this file's size</li><li><a href="mongogridfsfile.write.html">MongoGridFSFile::write</a> — Writes this file to the filesystem</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongogridfs.storeupload.html">MongoGridFS::storeUpload</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongogridfsfile.construct.html">MongoGridfsFile::__construct</a></div>
<div class="up"><a href="mongo.gridfs.html">GridFS Classes</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
