256 lines
14 KiB
HTML
256 lines
14 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>Validation of Documents — 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="validation-of-documents">
|
||
|
|
<h1>Validation of Documents<a class="headerlink" href="#validation-of-documents" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<p><em>Section author: Benjamin Eberlei <<a class="reference external" href="mailto:kontakt%40beberlei.de">kontakt<span>@</span>beberlei<span>.</span>de</a>></em></p>
|
||
|
|
<p>Doctrine does not ship with any internal validators, the reason
|
||
|
|
being that we think all the frameworks out there already ship with
|
||
|
|
quite decent ones that can be integrated into your Domain easily.
|
||
|
|
What we offer are hooks to execute any kind of validation.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">You don't need to validate your documents in the lifecycle
|
||
|
|
events. Its only one of many options. Of course you can also
|
||
|
|
perform validations in value setters or any other method of your
|
||
|
|
documents that are used in your code.</p>
|
||
|
|
</div>
|
||
|
|
<p>Documents can register lifecycle event methods with Doctrine that
|
||
|
|
are called on different occasions. For validation we would need to
|
||
|
|
hook into the events called before persisting and updating. Even
|
||
|
|
though we don't support validation out of the box, the
|
||
|
|
implementation is even simpler than in Doctrine 1 and you will get
|
||
|
|
the additional benefit of being able to re-use your validation in
|
||
|
|
any other part of your domain.</p>
|
||
|
|
<p>Say we have an <code class="docutils literal"><span class="pre">Order</span></code> with several <code class="docutils literal"><span class="pre">OrderLine</span></code> instances. We
|
||
|
|
never want to allow any customer to order for a larger sum than he
|
||
|
|
is allowed to:</p>
|
||
|
|
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
|
||
|
|
|
||
|
|
<span class="k">class</span> <span class="nc">Order</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">assertCustomerAllowedBuying</span><span class="p">()</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="nv">$orderLimit</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">customer</span><span class="o">-></span><span class="na">getOrderLimit</span><span class="p">();</span>
|
||
|
|
|
||
|
|
<span class="nv">$amount</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
|
||
|
|
<span class="k">foreach</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">orderLines</span> <span class="k">AS</span> <span class="nv">$line</span><span class="p">)</span> <span class="p">{</span>
|
||
|
|
<span class="nv">$amount</span> <span class="o">+=</span> <span class="nv">$line</span><span class="o">-></span><span class="na">getAmount</span><span class="p">();</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="k">if</span> <span class="p">(</span><span class="nv">$amount</span> <span class="o">></span> <span class="nv">$orderLimit</span><span class="p">)</span> <span class="p">{</span>
|
||
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nx">CustomerOrderLimitExceededException</span><span class="p">();</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Now this is some pretty important piece of business logic in your
|
||
|
|
code, enforcing it at any time is important so that customers with
|
||
|
|
a unknown reputation don't owe your business too much money.</p>
|
||
|
|
<p>We can enforce this constraint in any of the metadata drivers.
|
||
|
|
First Annotations:</p>
|
||
|
|
<div class="configuration-block">
|
||
|
|
<ul class="simple">
|
||
|
|
<li><em>PHP</em><div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Document @HasLifecycleCallbacks */</span>
|
||
|
|
<span class="k">class</span> <span class="nc">Order</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="sd">/** @PrePersist @PreUpdate */</span>
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">assertCustomerAllowedBuying</span><span class="p">()</span> <span class="p">{}</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li><em>XML</em><div class="highlight-xml"><div class="highlight"><pre><span class="nt"><doctrine-mapping></span>
|
||
|
|
<span class="nt"><document</span> <span class="na">name=</span><span class="s">"Order"</span><span class="nt">></span>
|
||
|
|
<span class="nt"><lifecycle-callbacks></span>
|
||
|
|
<span class="nt"><lifecycle-callback</span> <span class="na">type=</span><span class="s">"prePersist"</span> <span class="na">method=</span><span class="s">"assertCustomerallowedBuying"</span> <span class="nt">/></span>
|
||
|
|
<span class="nt"><lifecycle-callback</span> <span class="na">type=</span><span class="s">"preUpdate"</span> <span class="na">method=</span><span class="s">"assertCustomerallowedBuying"</span> <span class="nt">/></span>
|
||
|
|
<span class="nt"></lifecycle-callbacks></span>
|
||
|
|
<span class="nt"></document></span>
|
||
|
|
<span class="nt"></doctrine-mapping></span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<p>Now validation is performed whenever you call
|
||
|
|
<code class="docutils literal"><span class="pre">DocumentManager#persist($order)</span></code> or when you call
|
||
|
|
<code class="docutils literal"><span class="pre">DocumentManager#flush()</span></code> and an order is about to be updated. Any
|
||
|
|
Exception that happens in the lifecycle callbacks will be cached by
|
||
|
|
the DocumentManager and the current transaction is rolled back.</p>
|
||
|
|
<p>Of course you can do any type of primitive checks, not null,
|
||
|
|
email-validation, string size, integer and date ranges in your
|
||
|
|
validation callbacks.</p>
|
||
|
|
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Document @HasLifecycleCallbacks */</span>
|
||
|
|
<span class="k">class</span> <span class="nc">Order</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="sd">/** @PrePersist @PreUpdate */</span>
|
||
|
|
<span class="k">public</span> <span class="k">function</span> <span class="nf">validate</span><span class="p">()</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">plannedShipDate</span> <span class="nx">instanceof</span> <span class="nx">DateTime</span><span class="p">))</span> <span class="p">{</span>
|
||
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nx">ValidateException</span><span class="p">();</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">plannedShipDate</span><span class="o">-></span><span class="na">format</span><span class="p">(</span><span class="s1">'U'</span><span class="p">)</span> <span class="o"><</span> <span class="nb">time</span><span class="p">())</span> <span class="p">{</span>
|
||
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nx">ValidateException</span><span class="p">();</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">customer</span> <span class="o">==</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
|
||
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nx">OrderRequiresCustomerException</span><span class="p">();</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>What is nice about lifecycle events is, you can also re-use the
|
||
|
|
methods at other places in your domain, for example in combination
|
||
|
|
with your form library. Additionally there is no limitation in the
|
||
|
|
number of methods you register on one particular event, i.e. you
|
||
|
|
can register multiple methods for validation in "PrePersist" or
|
||
|
|
"PreUpdate" or mix and share them in any combinations between those
|
||
|
|
two events.</p>
|
||
|
|
<p>There is no limit to what you can and can't validate in
|
||
|
|
"PrePersist" and "PreUpdate" as long as you don't create new document
|
||
|
|
instances. This was already discussed in the previous blog post on
|
||
|
|
the Versionable extension, which requires another type of event
|
||
|
|
called "onFlush".</p>
|
||
|
|
<p>Further readings: <a class="reference internal" href="../reference/events.html"><span class="doc">Lifecycle Events</span></a></p>
|
||
|
|
</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/cookbook/validation-of-documents.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>
|