212 lines
10 KiB
HTML
212 lines
10 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>Best Practices — 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="best-practices">
|
||
|
|
<h1>Best Practices<a class="headerlink" href="#best-practices" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<p>Here are some best practices you can follow when working with the Doctrine MongoDB ODM.</p>
|
||
|
|
<div class="section" id="constrain-relationships-as-much-as-possible">
|
||
|
|
<h2>Constrain relationships as much as possible<a class="headerlink" href="#constrain-relationships-as-much-as-possible" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>It is important to constrain relationships as much as possible. This means:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>Impose a traversal direction (avoid bidirectional associations if possible)</li>
|
||
|
|
<li>Eliminate nonessential associations</li>
|
||
|
|
</ul>
|
||
|
|
<p>This has several benefits:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>Reduced coupling in your domain model</li>
|
||
|
|
<li>Simpler code in your domain model (no need to maintain bidirectionality properly)</li>
|
||
|
|
<li>Less work for Doctrine</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="use-events-judiciously">
|
||
|
|
<h2>Use events judiciously<a class="headerlink" href="#use-events-judiciously" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>The event system of Doctrine is great and fast. Even though making
|
||
|
|
heavy use of events, especially lifecycle events, can have a
|
||
|
|
negative impact on the performance of your application. Thus you
|
||
|
|
should use events judiciously.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="use-cascades-judiciously">
|
||
|
|
<h2>Use cascades judiciously<a class="headerlink" href="#use-cascades-judiciously" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Automatic cascades of the persist/remove/merge/etc. operations are
|
||
|
|
very handy but should be used wisely. Do NOT simply add all
|
||
|
|
cascades to all associations. Think about which cascades actually
|
||
|
|
do make sense for you for a particular association, given the
|
||
|
|
scenarios it is most likely used in.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="don-t-use-special-characters">
|
||
|
|
<h2>Don't use special characters<a class="headerlink" href="#don-t-use-special-characters" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Avoid using any non-ASCII characters in class, field, table or
|
||
|
|
column names. Doctrine itself is not unicode-safe in many places
|
||
|
|
and will not be until PHP itself is fully unicode-aware.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="initialize-collections-in-the-constructor">
|
||
|
|
<h2>Initialize collections in the constructor<a class="headerlink" href="#initialize-collections-in-the-constructor" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>It is recommended best practice to initialize any business
|
||
|
|
collections in documents in the constructor.</p>
|
||
|
|
<p>Example:</p>
|
||
|
|
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
|
||
|
|
|
||
|
|
<span class="k">namespace</span> <span class="nx">MyProject\Model</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="k">use</span> <span class="nx">Doctrine\Common\Collections\ArrayCollection</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="k">class</span> <span class="nc">User</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$addresses</span><span class="p">;</span>
|
||
|
|
<span class="k">private</span> <span class="nv">$articles</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">__construct</span><span class="p">()</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="nv">$this</span><span class="o">-></span><span class="na">addresses</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ArrayCollection</span><span class="p">;</span>
|
||
|
|
<span class="nv">$this</span><span class="o">-></span><span class="na">articles</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ArrayCollection</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
</pre></div>
|
||
|
|
</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><a href="../index.html">Table Of Contents</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">Best Practices</a><ul>
|
||
|
|
<li><a class="reference internal" href="#constrain-relationships-as-much-as-possible">Constrain relationships as much as possible</a></li>
|
||
|
|
<li><a class="reference internal" href="#use-events-judiciously">Use events judiciously</a></li>
|
||
|
|
<li><a class="reference internal" href="#use-cascades-judiciously">Use cascades judiciously</a></li>
|
||
|
|
<li><a class="reference internal" href="#don-t-use-special-characters">Don't use special characters</a></li>
|
||
|
|
<li><a class="reference internal" href="#initialize-collections-in-the-constructor">Initialize collections in the constructor</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="../_sources/reference/best-practices.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>
|