311 lines
18 KiB
HTML
311 lines
18 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>Storing Files with MongoGridFS — Doctrine MongoDB ODM 1.1.5 documentation</title>
|
||
|
|
<link rel="stylesheet" href="../_static/bootstrap/css/bootstrap.min.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="../_static/layout.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="../_static/configurationblock.css" type="text/css" />
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: '../',
|
||
|
|
VERSION: '1.1.5',
|
||
|
|
COLLAPSE_MODINDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/configurationblock.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/configurationblock.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/configurationblock.js"></script>
|
||
|
|
<script src="../_static/bootstrap/js/bootstrap.min.js"></script>
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
<!--
|
||
|
|
$(document).ready(function() {
|
||
|
|
$("#versions").change(function() {
|
||
|
|
var docsUrl = $(this).val();
|
||
|
|
window.location.href = docsUrl;
|
||
|
|
});
|
||
|
|
});
|
||
|
|
-->
|
||
|
|
</script>
|
||
|
|
<link rel="shortcut icon" href="../_static/doctrine.ico"/>
|
||
|
|
<link rel="search" title="Search" href="../search.html" />
|
||
|
|
<link rel="top" title="Doctrine MongoDB ODM 1.1.5 documentation" href="../index.html" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="wrapper">
|
||
|
|
<div id="header">
|
||
|
|
<h1 id="h1title"></h1>
|
||
|
|
<div id="logo">
|
||
|
|
<a href="http://www.doctrine-project.org/">Doctrine - PHP Database Libraries</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="nav" class="cls">
|
||
|
|
<div class="tl cls">
|
||
|
|
<ul>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/">Home</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/about.html">About</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/projects.html">Projects</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/contribute.html">Contribute</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/community.html">Community</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/archive.html">Blog</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/jira">Development</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="content" class="cls">
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li><a href="/">Doctrine Homepage</a> »</li>
|
||
|
|
<li><a href="../index.html">Doctrine MongoDB ODM 1.1.5 documentation</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
|
||
|
|
<div class="body" >
|
||
|
|
|
||
|
|
<div class="section" id="storing-files-with-mongogridfs">
|
||
|
|
<h1>Storing Files with MongoGridFS<a class="headerlink" href="#storing-files-with-mongogridfs" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<p>The PHP Mongo extension provides a nice and convenient way to store
|
||
|
|
files in chunks of data with the
|
||
|
|
<a class="reference external" href="http://us.php.net/manual/en/class.mongogridfs.php">MongoGridFS</a>.</p>
|
||
|
|
<p>It uses two database collections, one to store the metadata for the
|
||
|
|
file, and another to store the contents of the file. The contents
|
||
|
|
are stored in chunks to avoid going over the maximum allowed size
|
||
|
|
of a MongoDB document.</p>
|
||
|
|
<p>You can easily setup a Document that is stored using the
|
||
|
|
MongoGridFS:</p>
|
||
|
|
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
|
||
|
|
|
||
|
|
<span class="k">namespace</span> <span class="nx">Documents</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Document */</span>
|
||
|
|
<span class="k">class</span> <span class="nc">Image</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="sd">/** @Id */</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$id</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Field */</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$name</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @File */</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$file</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Field */</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$uploadDate</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Field */</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$length</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Field */</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$chunkSize</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Field */</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$md5</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">getId</span><span class="p">()</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="k">return</span> <span class="nv">$this</span><span class="o">-></span><span class="na">id</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">setName</span><span class="p">(</span><span class="nv">$name</span><span class="p">)</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="nv">$this</span><span class="o">-></span><span class="na">name</span> <span class="o">=</span> <span class="nv">$name</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">getName</span><span class="p">()</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="k">return</span> <span class="nv">$this</span><span class="o">-></span><span class="na">name</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">getFile</span><span class="p">()</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="k">return</span> <span class="nv">$this</span><span class="o">-></span><span class="na">file</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">setFile</span><span class="p">(</span><span class="nv">$file</span><span class="p">)</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="nv">$this</span><span class="o">-></span><span class="na">file</span> <span class="o">=</span> <span class="nv">$file</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Notice how we annotated the $file property with @File. This is what
|
||
|
|
tells the Document that it is to be stored using the MongoGridFS
|
||
|
|
and the MongoGridFSFile instance is placed in the $file property
|
||
|
|
for you to access the actual file itself.</p>
|
||
|
|
<p>The $uploadDate, $chunkSize and $md5 properties are automatically filled in
|
||
|
|
for each file stored in GridFS (whether you like that or not).
|
||
|
|
Feel free to create getters in your document to actually make use of them,
|
||
|
|
but keep in mind that their values will be initially unset for new objects
|
||
|
|
until the next time the document is hydrated (fetched from the database).</p>
|
||
|
|
<p>First you need to create a new Image:</p>
|
||
|
|
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
|
||
|
|
|
||
|
|
<span class="nv">$image</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Image</span><span class="p">();</span>
|
||
|
|
<span class="nv">$image</span><span class="o">-></span><span class="na">setName</span><span class="p">(</span><span class="s1">'Test image'</span><span class="p">);</span>
|
||
|
|
<span class="nv">$image</span><span class="o">-></span><span class="na">setFile</span><span class="p">(</span><span class="s1">'/path/to/image.png'</span><span class="p">);</span>
|
||
|
|
|
||
|
|
<span class="nv">$dm</span><span class="o">-></span><span class="na">persist</span><span class="p">(</span><span class="nv">$image</span><span class="p">);</span>
|
||
|
|
<span class="nv">$dm</span><span class="o">-></span><span class="na">flush</span><span class="p">();</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Now you can later query for the Image and render it:</p>
|
||
|
|
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
|
||
|
|
|
||
|
|
<span class="nv">$image</span> <span class="o">=</span> <span class="nv">$dm</span><span class="o">-></span><span class="na">createQueryBuilder</span><span class="p">(</span><span class="s1">'Documents\Image'</span><span class="p">)</span>
|
||
|
|
<span class="o">-></span><span class="na">field</span><span class="p">(</span><span class="s1">'name'</span><span class="p">)</span><span class="o">-></span><span class="na">equals</span><span class="p">(</span><span class="s1">'Test image'</span><span class="p">)</span>
|
||
|
|
<span class="o">-></span><span class="na">getQuery</span><span class="p">()</span>
|
||
|
|
<span class="o">-></span><span class="na">getSingleResult</span><span class="p">();</span>
|
||
|
|
|
||
|
|
<span class="nb">header</span><span class="p">(</span><span class="s1">'Content-type: image/png;'</span><span class="p">);</span>
|
||
|
|
<span class="k">echo</span> <span class="nv">$image</span><span class="o">-></span><span class="na">getFile</span><span class="p">()</span><span class="o">-></span><span class="na">getBytes</span><span class="p">();</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>You can of course make references to this Image document from
|
||
|
|
another document. Imagine you had a Profile document and you wanted
|
||
|
|
every Profile to have a profile image:</p>
|
||
|
|
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
|
||
|
|
|
||
|
|
<span class="k">namespace</span> <span class="nx">Documents</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Document */</span>
|
||
|
|
<span class="k">class</span> <span class="nc">Profile</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="sd">/** @Id */</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$id</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Field */</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$name</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @ReferenceOne(targetDocument="Documents\Image") */</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$image</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">getId</span><span class="p">()</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="k">return</span> <span class="nv">$this</span><span class="o">-></span><span class="na">id</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">getName</span><span class="p">()</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="k">return</span> <span class="nv">$this</span><span class="o">-></span><span class="na">name</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">setName</span><span class="p">(</span><span class="nv">$name</span><span class="p">)</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="nv">$this</span><span class="o">-></span><span class="na">name</span> <span class="o">=</span> <span class="nv">$name</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">getImage</span><span class="p">()</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="k">return</span> <span class="nv">$this</span><span class="o">-></span><span class="na">image</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">setImage</span><span class="p">(</span><span class="nx">Image</span> <span class="nv">$image</span><span class="p">)</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="nv">$this</span><span class="o">-></span><span class="na">image</span> <span class="o">=</span> <span class="nv">$image</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Now you can create a new Profile and give it an Image:</p>
|
||
|
|
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
|
||
|
|
|
||
|
|
<span class="nv">$image</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Image</span><span class="p">();</span>
|
||
|
|
<span class="nv">$image</span><span class="o">-></span><span class="na">setName</span><span class="p">(</span><span class="s1">'Test image'</span><span class="p">);</span>
|
||
|
|
<span class="nv">$image</span><span class="o">-></span><span class="na">setFile</span><span class="p">(</span><span class="s1">'/path/to/image.png'</span><span class="p">);</span>
|
||
|
|
|
||
|
|
<span class="nv">$profile</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Profile</span><span class="p">();</span>
|
||
|
|
<span class="nv">$profile</span><span class="o">-></span><span class="na">setName</span><span class="p">(</span><span class="s1">'Jonathan H. Wage'</span><span class="p">);</span>
|
||
|
|
<span class="nv">$profile</span><span class="o">-></span><span class="na">setImage</span><span class="p">(</span><span class="nv">$image</span><span class="p">);</span>
|
||
|
|
|
||
|
|
<span class="nv">$dm</span><span class="o">-></span><span class="na">persist</span><span class="p">(</span><span class="nv">$profile</span><span class="p">);</span>
|
||
|
|
<span class="nv">$dm</span><span class="o">-></span><span class="na">flush</span><span class="p">();</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>If you want to query for the Profile and load the Image reference
|
||
|
|
in a query you can use:</p>
|
||
|
|
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
|
||
|
|
|
||
|
|
<span class="nv">$profile</span> <span class="o">=</span> <span class="nv">$dm</span><span class="o">-></span><span class="na">createQueryBuilder</span><span class="p">(</span><span class="s1">'Profile'</span><span class="p">)</span>
|
||
|
|
<span class="o">-></span><span class="na">field</span><span class="p">(</span><span class="s1">'name'</span><span class="p">)</span><span class="o">-></span><span class="na">equals</span><span class="p">(</span><span class="s1">'Jonathan H. Wage'</span><span class="p">)</span>
|
||
|
|
<span class="o">-></span><span class="na">getQuery</span><span class="p">()</span>
|
||
|
|
<span class="o">-></span><span class="na">getSingleResult</span><span class="p">();</span>
|
||
|
|
|
||
|
|
<span class="nv">$image</span> <span class="o">=</span> <span class="nv">$profile</span><span class="o">-></span><span class="na">getImage</span><span class="p">();</span>
|
||
|
|
|
||
|
|
<span class="nb">header</span><span class="p">(</span><span class="s1">'Content-type: image/png;'</span><span class="p">);</span>
|
||
|
|
<span class="k">echo</span> <span class="nv">$image</span><span class="o">-></span><span class="na">getFile</span><span class="p">()</span><span class="o">-></span><span class="na">getBytes</span><span class="p">();</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
|
||
|
|
<div id="searchbox" style="">
|
||
|
|
<h3>Search</h3>
|
||
|
|
<form class="search" action="http://readthedocs.org/search/project/" method="get">
|
||
|
|
<input type="text" name="q" size="18">
|
||
|
|
<input type="submit" value="Go">
|
||
|
|
<input type="hidden" name="selected_facets" value="project:">
|
||
|
|
</form>
|
||
|
|
</div>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="../_sources/reference/storing-files-with-mongogridfs.rst.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2013, Doctrine Project Team.
|
||
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.6.2.
|
||
|
|
<br/>
|
||
|
|
<a target="_BLANK" href="http://www.servergrove.com"><img src="http://www.doctrine-project.org/_static/servergrove.jpg" /></a> <br/><br/>
|
||
|
|
<form action="https://www.paypal.com/cgi-bin/webscr" method="post">
|
||
|
|
<input type="hidden" name="cmd" value="_s-xclick" />
|
||
|
|
<input type="hidden" name="hosted_button_id" value="BAE2E3XANQ77Y" />
|
||
|
|
<input type="image" src="https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!" />
|
||
|
|
<img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1" />
|
||
|
|
</form>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="bot-rcnr">
|
||
|
|
<div class="tl"><!-- corner --></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
_uacct = "UA-288343-7";
|
||
|
|
urchinTracker();
|
||
|
|
</script>
|
||
|
|
<a class="githublink" href="http://github.com/doctrine"><img src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" alt="Fork me on GitHub"></a>
|
||
|
|
</body>
|
||
|
|
</html>
|