/usr/share/doc/php-doctrine-orm/html/reference/yaml-mapping.html is in doctrine-orm-doc 2.4.6-1+deb8u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 | <!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>21. YAML Mapping — Doctrine 2 ORM 2 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: '2',
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="top" title="Doctrine 2 ORM 2 documentation" href="../index.html" />
<link rel="next" title="22. Annotations Reference" href="annotations-reference.html" />
<link rel="prev" title="20. XML Mapping" href="xml-mapping.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="/">home</a></li>
<li><a class="" target="_top" href="http://www.doctrine-project.org/about">about</a></li>
<li><a class="" target="_top" href="http://www.doctrine-project.org/projects.html">projects</a></li>
<li><a class="" target="_top" href="http://www.doctrine-project.org/projects/orm">orm</a></li>
<li><a class="" target="_top" href="http://www.doctrine-project.org/projects/dbal">dbal</a></li>
<li><a class="" target="_top" href="http://www.doctrine-project.org/blog">blog</a></li>
<li><a class="" target="_top" href="http://www.doctrine-project.org/jira">development</a></li>
<li><a class="" target="_top" href="http://www.doctrine-project.org/contribute">contribute</a></li>
<li><a class="" target="_top" href="http://www.doctrine-project.org/community">community</a></li>
</ul>
</div>
</div>
<div id="content" class="cls">
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="annotations-reference.html" title="22. Annotations Reference"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="xml-mapping.html" title="20. XML Mapping"
accesskey="P">previous</a> |</li>
<li><a href="/">Doctrine Homepage</a> »</li>
<li><a href="../index.html">Doctrine 2 ORM 2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" >
<div class="section" id="yaml-mapping">
<h1>21. YAML Mapping<a class="headerlink" href="#yaml-mapping" title="Permalink to this headline">¶</a></h1>
<p>The YAML mapping driver enables you to provide the ORM metadata in
form of YAML documents.</p>
<p>The YAML mapping document of a class is loaded on-demand the first
time it is requested and subsequently stored in the metadata cache.
In order to work, this requires certain conventions:</p>
<ul class="simple">
<li>Each entity/mapped superclass must get its own dedicated YAML
mapping document.</li>
<li>The name of the mapping document must consist of the fully
qualified name of the class, where namespace separators are
replaced by dots (.).</li>
<li>All mapping documents should get the extension ”.dcm.yml” to
identify it as a Doctrine mapping file. This is more of a
convention and you are not forced to do this. You can change the
file extension easily enough.</li>
</ul>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nv">$driver</span><span class="o">-></span><span class="na">setFileExtension</span><span class="p">(</span><span class="s1">'.yml'</span><span class="p">);</span>
</pre></div>
</div>
<p>It is recommended to put all YAML mapping documents in a single
folder but you can spread the documents over several folders if you
want to. In order to tell the YamlDriver where to look for your
mapping documents, supply an array of paths as the first argument
of the constructor, like this:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">use</span> <span class="nx">Doctrine\ORM\Mapping\Driver\YamlDriver</span><span class="p">;</span>
<span class="c1">// $config instanceof Doctrine\ORM\Configuration</span>
<span class="nv">$driver</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">YamlDriver</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">'/path/to/files'</span><span class="p">));</span>
<span class="nv">$config</span><span class="o">-></span><span class="na">setMetadataDriverImpl</span><span class="p">(</span><span class="nv">$driver</span><span class="p">);</span>
</pre></div>
</div>
<div class="section" id="simplified-yaml-driver">
<h2>21.1. Simplified YAML Driver<a class="headerlink" href="#simplified-yaml-driver" title="Permalink to this headline">¶</a></h2>
<p>The Symfony project sponsored a driver that simplifies usage of the YAML Driver.
The changes between the original driver are:</p>
<ul class="simple">
<li>File Extension is .orm.yml</li>
<li>Filenames are shortened, “MyProject\Entities\User” will become User.orm.yml</li>
<li>You can add a global file and add multiple entities in this file.</li>
</ul>
<p>Configuration of this client works a little bit different:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nv">$namespaces</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'/path/to/files1'</span> <span class="o">=></span> <span class="s1">'MyProject\Entities'</span><span class="p">,</span>
<span class="s1">'/path/to/files2'</span> <span class="o">=></span> <span class="s1">'OtherProject\Entities'</span>
<span class="p">);</span>
<span class="nv">$driver</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\Doctrine\ORM\Mapping\Driver\SimplifiedYamlDriver</span><span class="p">(</span><span class="nv">$namespaces</span><span class="p">);</span>
<span class="nv">$driver</span><span class="o">-></span><span class="na">setGlobalBasename</span><span class="p">(</span><span class="s1">'global'</span><span class="p">);</span> <span class="c1">// global.orm.yml</span>
</pre></div>
</div>
<div class="section" id="example">
<h3>21.1.1. Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
<p>As a quick start, here is a small example document that makes use
of several common elements:</p>
<div class="highlight-yaml"><div class="highlight"><pre><span class="c1"># Doctrine.Tests.ORM.Mapping.User.dcm.yml</span>
<span class="l-Scalar-Plain">Doctrine\Tests\ORM\Mapping\User</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">type</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">entity</span>
<span class="l-Scalar-Plain">table</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">cms_users</span>
<span class="l-Scalar-Plain">indexes</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">name_index</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">columns</span><span class="p-Indicator">:</span> <span class="p-Indicator">[</span> <span class="nv">name</span> <span class="p-Indicator">]</span>
<span class="l-Scalar-Plain">id</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">id</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">type</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">integer</span>
<span class="l-Scalar-Plain">generator</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">strategy</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">AUTO</span>
<span class="l-Scalar-Plain">fields</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">type</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">string</span>
<span class="l-Scalar-Plain">length</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">50</span>
<span class="l-Scalar-Plain">oneToOne</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">address</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">targetEntity</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Address</span>
<span class="l-Scalar-Plain">joinColumn</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">address_id</span>
<span class="l-Scalar-Plain">referencedColumnName</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">id</span>
<span class="l-Scalar-Plain">oneToMany</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">phonenumbers</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">targetEntity</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Phonenumber</span>
<span class="l-Scalar-Plain">mappedBy</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">user</span>
<span class="l-Scalar-Plain">cascade</span><span class="p-Indicator">:</span> <span class="p-Indicator">[</span><span class="s">"persist"</span><span class="p-Indicator">,</span> <span class="s">"merge"</span><span class="p-Indicator">]</span>
<span class="l-Scalar-Plain">manyToMany</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">groups</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">targetEntity</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Group</span>
<span class="l-Scalar-Plain">joinTable</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">cms_users_groups</span>
<span class="l-Scalar-Plain">joinColumns</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">user_id</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">referencedColumnName</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">id</span>
<span class="l-Scalar-Plain">inverseJoinColumns</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">group_id</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">referencedColumnName</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">id</span>
<span class="l-Scalar-Plain">lifecycleCallbacks</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">prePersist</span><span class="p-Indicator">:</span> <span class="p-Indicator">[</span> <span class="nv">doStuffOnPrePersist</span><span class="p-Indicator">,</span> <span class="nv">doOtherStuffOnPrePersistToo</span> <span class="p-Indicator">]</span>
<span class="l-Scalar-Plain">postPersist</span><span class="p-Indicator">:</span> <span class="p-Indicator">[</span> <span class="nv">doStuffOnPostPersist</span> <span class="p-Indicator">]</span>
</pre></div>
</div>
<p>Be aware that class-names specified in the YAML files should be
fully qualified.</p>
</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="#">21. YAML Mapping</a><ul>
<li><a class="reference internal" href="#simplified-yaml-driver">21.1. Simplified YAML Driver</a><ul>
<li><a class="reference internal" href="#example">21.1.1. Example</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="xml-mapping.html"
title="previous chapter">20. XML Mapping</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="annotations-reference.html"
title="next chapter">22. Annotations Reference</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/reference/yaml-mapping.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2010-12, Doctrine Project Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2.3.
<br/>
<a target="_BLANK" href="http://www.servergrove.com"><img src="../_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="Submit" value="Donate via PayPal" />
</form>
</div>
</div>
<div id="bot-rcnr">
<div class="tl"><!-- corner --></div>
</div>
</div>
<a class="githublink" href="http://github.com/doctrine">Fork me on GitHub</a>
</body>
</html>
|