mongodb-odm-docs-dash/Doctrine ODM.docset/Contents/Resources/Documents/index.html

250 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>Doctrine MongoDB ODM's documentation! &mdash; 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="#" />
</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> &raquo;</li>
<li><a href="#">Doctrine MongoDB ODM 1.1.5 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" >
<div class="section" id="doctrine-mongodb-odm-s-documentation">
<h1>Doctrine MongoDB ODM's documentation!<a class="headerlink" href="#doctrine-mongodb-odm-s-documentation" title="Permalink to this headline"></a></h1>
<p>The Doctrine MongoDB ODM documentation is comprised of tutorials, a reference section and
cookbook articles that explain different parts of the Object Document mapper.</p>
<div class="section" id="getting-help">
<h2>Getting Help<a class="headerlink" href="#getting-help" title="Permalink to this headline"></a></h2>
<p>If this documentation is not helping to answer questions you have about
Doctrine MongoDB ODM don't panic. You can get help from different sources:</p>
<ul class="simple">
<li>The <a class="reference external" href="http://groups.google.com/group/doctrine-user">Doctrine Mailing List</a></li>
<li>Internet Relay Chat (IRC) in <a class="reference external" href="irc://irc.freenode.net/doctrine">#doctrine on Freenode</a></li>
<li>Report a bug on <a class="reference external" href="https://github.com/doctrine/mongodb-odm/issues">GitHub</a>.</li>
<li>On <a class="reference external" href="http://stackoverflow.com/questions/tagged/doctrine-odm">StackOverflow</a></li>
</ul>
</div>
<div class="section" id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h2>
<blockquote>
<div><a class="reference internal" href="tutorials/getting-started.html"><span class="doc">Getting Started</span></a> |
<a class="reference internal" href="reference/introduction.html"><span class="doc">Introduction</span></a> |
<a class="reference internal" href="reference/architecture.html"><span class="doc">Architecture</span></a></div></blockquote>
</div>
<div class="section" id="mapping-objects-onto-a-database">
<h2>Mapping Objects onto a Database<a class="headerlink" href="#mapping-objects-onto-a-database" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><strong>Basic Reference</strong>:
<a class="reference internal" href="reference/basic-mapping.html"><span class="doc">Objects and Fields</span></a> |
<a class="reference internal" href="reference/reference-mapping.html"><span class="doc">References</span></a> |
<a class="reference internal" href="reference/bidirectional-references.html"><span class="doc">Bi-Directional References</span></a> |
<a class="reference internal" href="reference/complex-references.html"><span class="doc">Complex References</span></a> |
<a class="reference internal" href="reference/indexes.html"><span class="doc">Indexes</span></a> |
<a class="reference internal" href="reference/inheritance-mapping.html"><span class="doc">Inheritance</span></a></li>
<li><strong>Embedded Data</strong>:
<a class="reference internal" href="reference/embedded-mapping.html"><span class="doc">Embedded</span></a> |
<a class="reference internal" href="reference/trees.html"><span class="doc">Trees</span></a></li>
<li><strong>GridFS</strong>:
<a class="reference internal" href="reference/storing-files-with-mongogridfs.html"><span class="doc">Storing Files in GridFS</span></a></li>
<li><strong>Mapping Driver References</strong>:
<a class="reference internal" href="reference/xml-mapping.html"><span class="doc">XML</span></a> |
<a class="reference internal" href="reference/yml-mapping.html"><span class="doc">YAML</span></a> |
<a class="reference internal" href="reference/annotations-reference.html"><span class="doc">Docblock Annotations</span></a> |
<a class="reference internal" href="reference/metadata-drivers.html"><span class="doc">Metadata Drivers</span></a></li>
</ul>
</div>
<div class="section" id="working-with-objects">
<h2>Working with Objects<a class="headerlink" href="#working-with-objects" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><strong>Basic Reference</strong>:
<a class="reference internal" href="reference/working-with-objects.html"><span class="doc">Documents</span></a> |
<a class="reference internal" href="reference/document-repositories.html"><span class="doc">Repositories</span></a> |
<a class="reference internal" href="reference/events.html"><span class="doc">Events</span></a> |
<a class="reference internal" href="reference/migrating-schemas.html"><span class="doc">Migrations</span></a></li>
<li><strong>Query Reference</strong>:
<a class="reference internal" href="reference/query-builder-api.html"><span class="doc">Query Builder API</span></a> |
<a class="reference internal" href="reference/aggregation-builder.html"><span class="doc">Aggregation Pipeline queries</span></a> |
<a class="reference internal" href="reference/geospatial-queries.html"><span class="doc">Geo Spatial Queries</span></a> |
<a class="reference internal" href="reference/slave-okay-queries.html"><span class="doc">Slave Okay Queries</span></a> |
<a class="reference internal" href="reference/find-and-update.html"><span class="doc">Find and Update</span></a> |
<a class="reference internal" href="reference/filters.html"><span class="doc">Filters</span></a> |
<a class="reference internal" href="reference/priming-references.html"><span class="doc">Priming References</span></a> |
<a class="reference internal" href="reference/eager-cursors.html"><span class="doc">Eager Cursors</span></a> |
<a class="reference internal" href="reference/map-reduce.html"><span class="doc">Map Reduce</span></a></li>
</ul>
</div>
<div class="section" id="advanced-topics">
<h2>Advanced Topics<a class="headerlink" href="#advanced-topics" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><strong>Collections</strong>:
<a class="reference internal" href="reference/capped-collections.html"><span class="doc">Capped Collections</span></a> |
<a class="reference internal" href="reference/storage-strategies.html"><span class="doc">Storage Strategies</span></a> |
<a class="reference internal" href="reference/custom-collections.html"><span class="doc">Custom Collections</span></a> |
<a class="reference internal" href="reference/sharding.html"><span class="doc">Sharded setups</span></a></li>
<li><strong>Transactions and Concurrency</strong>:
<a class="reference internal" href="reference/transactions-and-concurrency.html"><span class="doc">Transactions and Concurrency</span></a></li>
<li><strong>Best Practices</strong>:
<a class="reference internal" href="reference/best-practices.html"><span class="doc">Best Practices</span></a></li>
<li><strong>Performance</strong>:
<a class="reference internal" href="reference/change-tracking-policies.html"><span class="doc">Change Tracking Policies</span></a></li>
<li><strong>Logging</strong>:
<a class="reference internal" href="reference/logging.html"><span class="doc">Logging</span></a></li>
</ul>
</div>
<div class="section" id="cookbook">
<h2>Cookbook<a class="headerlink" href="#cookbook" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><strong>Examples</strong>:
<a class="reference internal" href="cookbook/soft-delete-extension.html"><span class="doc">Soft Delete</span></a> |
<a class="reference internal" href="cookbook/simple-search-engine.html"><span class="doc">Simple Search Engine</span></a></li>
<li><strong>Tricks</strong>:
<a class="reference internal" href="cookbook/blending-orm-and-mongodb-odm.html"><span class="doc">Blending ORM and MongoDB ODM</span></a> |
<a class="reference internal" href="cookbook/mapping-classes-to-orm-and-odm.html"><span class="doc">Mapping classes to ORM and ODM</span></a></li>
<li><strong>Implementation</strong>:
<a class="reference internal" href="cookbook/implementing-array-access-for-domain-objects.html"><span class="doc">Array Access</span></a> |
<a class="reference internal" href="cookbook/implementing-the-notify-changetracking-policy.html"><span class="doc">Notify ChangeTracking Example</span></a> |
<a class="reference internal" href="cookbook/implementing-wakeup-or-clone.html"><span class="doc">Using Wakeup Or Clone</span></a> |
<a class="reference internal" href="cookbook/validation-of-documents.html"><span class="doc">Validation</span></a> |
<a class="reference internal" href="cookbook/simple-search-engine.html"><span class="doc">Simple Search Engine</span></a> |
<a class="reference internal" href="cookbook/resolve-target-document-listener.html"><span class="doc">Keeping Your Modules Independent</span></a></li>
</ul>
</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="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Doctrine MongoDB ODM's documentation!</a><ul>
<li><a class="reference internal" href="#getting-help">Getting Help</a></li>
<li><a class="reference internal" href="#getting-started">Getting Started</a></li>
<li><a class="reference internal" href="#mapping-objects-onto-a-database">Mapping Objects onto a Database</a></li>
<li><a class="reference internal" href="#working-with-objects">Working with Objects</a></li>
<li><a class="reference internal" href="#advanced-topics">Advanced Topics</a></li>
<li><a class="reference internal" href="#cookbook">Cookbook</a></li>
</ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy; 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>