/usr/share/doc/php-doctrine-orm/html/reference/php-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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 | <!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>23. PHP 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="24. Caching" href="caching.html" />
<link rel="prev" title="22. Annotations Reference" href="annotations-reference.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="caching.html" title="24. Caching"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="annotations-reference.html" title="22. Annotations Reference"
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="php-mapping">
<h1>23. PHP Mapping<a class="headerlink" href="#php-mapping" title="Permalink to this headline">¶</a></h1>
<p>Doctrine 2 also allows you to provide the ORM metadata in the form
of plain PHP code using the <tt class="docutils literal"><span class="pre">ClassMetadata</span></tt> API. You can write
the code in PHP files or inside of a static function named
<tt class="docutils literal"><span class="pre">loadMetadata($class)</span></tt> on the entity class itself.</p>
<div class="section" id="php-files">
<h2>23.1. PHP Files<a class="headerlink" href="#php-files" title="Permalink to this headline">¶</a></h2>
<p>If you wish to write your mapping information inside PHP files that
are named after the entity and included to populate the metadata
for an entity you can do so by using the <tt class="docutils literal"><span class="pre">PHPDriver</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nv">$driver</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PHPDriver</span><span class="p">(</span><span class="s1">'/path/to/php/mapping/files'</span><span class="p">);</span>
<span class="nv">$em</span><span class="o">-></span><span class="na">getConfiguration</span><span class="p">()</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>
<p>Now imagine we had an entity named <tt class="docutils literal"><span class="pre">Entities\User</span></tt> and we wanted
to write a mapping file for it using the above configured
<tt class="docutils literal"><span class="pre">PHPDriver</span></tt> instance:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">namespace</span> <span class="nx">Entities</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">$id</span><span class="p">;</span>
<span class="k">private</span> <span class="nv">$username</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<p>To write the mapping information you just need to create a file
named <tt class="docutils literal"><span class="pre">Entities.User.php</span></tt> inside of the
<tt class="docutils literal"><span class="pre">/path/to/php/mapping/files</span></tt> folder:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// /path/to/php/mapping/files/Entities.User.php</span>
<span class="nv">$metadata</span><span class="o">-></span><span class="na">mapField</span><span class="p">(</span><span class="k">array</span><span class="p">(</span>
<span class="s1">'id'</span> <span class="o">=></span> <span class="k">true</span><span class="p">,</span>
<span class="s1">'fieldName'</span> <span class="o">=></span> <span class="s1">'id'</span><span class="p">,</span>
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'integer'</span>
<span class="p">));</span>
<span class="nv">$metadata</span><span class="o">-></span><span class="na">mapField</span><span class="p">(</span><span class="k">array</span><span class="p">(</span>
<span class="s1">'fieldName'</span> <span class="o">=></span> <span class="s1">'username'</span><span class="p">,</span>
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'string'</span>
<span class="p">));</span>
</pre></div>
</div>
<p>Now we can easily retrieve the populated <tt class="docutils literal"><span class="pre">ClassMetadata</span></tt> instance
where the <tt class="docutils literal"><span class="pre">PHPDriver</span></tt> includes the file and the
<tt class="docutils literal"><span class="pre">ClassMetadataFactory</span></tt> caches it for later retrieval:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nv">$class</span> <span class="o">=</span> <span class="nv">$em</span><span class="o">-></span><span class="na">getClassMetadata</span><span class="p">(</span><span class="s1">'Entities\User'</span><span class="p">);</span>
<span class="c1">// or</span>
<span class="nv">$class</span> <span class="o">=</span> <span class="nv">$em</span><span class="o">-></span><span class="na">getMetadataFactory</span><span class="p">()</span><span class="o">-></span><span class="na">getMetadataFor</span><span class="p">(</span><span class="s1">'Entities\User'</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="static-function">
<h2>23.2. Static Function<a class="headerlink" href="#static-function" title="Permalink to this headline">¶</a></h2>
<p>In addition to the PHP files you can also specify your mapping
information inside of a static function defined on the entity class
itself. This is useful for cases where you want to keep your entity
and mapping information together but don’t want to use annotations.
For this you just need to use the <tt class="docutils literal"><span class="pre">StaticPHPDriver</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nv">$driver</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">StaticPHPDriver</span><span class="p">(</span><span class="s1">'/path/to/entities'</span><span class="p">);</span>
<span class="nv">$em</span><span class="o">-></span><span class="na">getConfiguration</span><span class="p">()</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>
<p>Now you just need to define a static function named
<tt class="docutils literal"><span class="pre">loadMetadata($metadata)</span></tt> on your entity:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">namespace</span> <span class="nx">Entities</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">Doctrine\ORM\Mapping\ClassMetadata</span><span class="p">;</span>
<span class="k">class</span> <span class="nc">User</span>
<span class="p">{</span>
<span class="c1">// ...</span>
<span class="k">public</span> <span class="k">static</span> <span class="k">function</span> <span class="nf">loadMetadata</span><span class="p">(</span><span class="nx">ClassMetadata</span> <span class="nv">$metadata</span><span class="p">)</span>
<span class="p">{</span>
<span class="nv">$metadata</span><span class="o">-></span><span class="na">mapField</span><span class="p">(</span><span class="k">array</span><span class="p">(</span>
<span class="s1">'id'</span> <span class="o">=></span> <span class="k">true</span><span class="p">,</span>
<span class="s1">'fieldName'</span> <span class="o">=></span> <span class="s1">'id'</span><span class="p">,</span>
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'integer'</span>
<span class="p">));</span>
<span class="nv">$metadata</span><span class="o">-></span><span class="na">mapField</span><span class="p">(</span><span class="k">array</span><span class="p">(</span>
<span class="s1">'fieldName'</span> <span class="o">=></span> <span class="s1">'username'</span><span class="p">,</span>
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'string'</span>
<span class="p">));</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="classmetadatabuilder">
<h2>23.3. ClassMetadataBuilder<a class="headerlink" href="#classmetadatabuilder" title="Permalink to this headline">¶</a></h2>
<p>To ease the use of the ClassMetadata API (which is very raw) there is a <tt class="docutils literal"><span class="pre">ClassMetadataBuilder</span></tt> that you can use.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">namespace</span> <span class="nx">Entities</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">Doctrine\ORM\Mapping\ClassMetadata</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder</span><span class="p">;</span>
<span class="k">class</span> <span class="nc">User</span>
<span class="p">{</span>
<span class="c1">// ...</span>
<span class="k">public</span> <span class="k">static</span> <span class="k">function</span> <span class="nf">loadMetadata</span><span class="p">(</span><span class="nx">ClassMetadata</span> <span class="nv">$metadata</span><span class="p">)</span>
<span class="p">{</span>
<span class="nv">$builder</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ClassMetadataBuilder</span><span class="p">(</span><span class="nv">$metadata</span><span class="p">);</span>
<span class="nv">$builder</span><span class="o">-></span><span class="na">createField</span><span class="p">(</span><span class="s1">'id'</span><span class="p">,</span> <span class="s1">'integer'</span><span class="p">)</span><span class="o">-></span><span class="na">isPrimaryKey</span><span class="p">()</span><span class="o">-></span><span class="na">generatedValue</span><span class="p">()</span><span class="o">-></span><span class="na">build</span><span class="p">();</span>
<span class="nv">$builder</span><span class="o">-></span><span class="na">addField</span><span class="p">(</span><span class="s1">'username'</span><span class="p">,</span> <span class="s1">'string'</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The API of the ClassMetadataBuilder has the following methods with a fluent interface:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">addField($name,</span> <span class="pre">$type,</span> <span class="pre">array</span> <span class="pre">$mapping)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setMappedSuperclass()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setReadOnly()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setCustomRepositoryClass($className)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setTable($name)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">addIndex(array</span> <span class="pre">$columns,</span> <span class="pre">$indexName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">addUniqueConstraint(array</span> <span class="pre">$columns,</span> <span class="pre">$constraintName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">addNamedQuery($name,</span> <span class="pre">$dqlQuery)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setJoinedTableInheritance()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setSingleTableInheritance()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setDiscriminatorColumn($name,</span> <span class="pre">$type</span> <span class="pre">=</span> <span class="pre">'string',</span> <span class="pre">$length</span> <span class="pre">=</span> <span class="pre">255)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">addDiscriminatorMapClass($name,</span> <span class="pre">$class)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setChangeTrackingPolicyDeferredExplicit()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setChangeTrackingPolicyNotify()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">addLifecycleEvent($methodName,</span> <span class="pre">$event)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">addManyToOne($name,</span> <span class="pre">$targetEntity,</span> <span class="pre">$inversedBy</span> <span class="pre">=</span> <span class="pre">null)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">addInverseOneToOne($name,</span> <span class="pre">$targetEntity,</span> <span class="pre">$mappedBy)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">addOwningOneToOne($name,</span> <span class="pre">$targetEntity,</span> <span class="pre">$inversedBy</span> <span class="pre">=</span> <span class="pre">null)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">addOwningManyToMany($name,</span> <span class="pre">$targetEntity,</span> <span class="pre">$inversedBy</span> <span class="pre">=</span> <span class="pre">null)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">addInverseManyToMany($name,</span> <span class="pre">$targetEntity,</span> <span class="pre">$mappedBy)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">addOneToMany($name,</span> <span class="pre">$targetEntity,</span> <span class="pre">$mappedBy)</span></tt></li>
</ul>
<p>It also has several methods that create builders (which are necessary for advanced mappings):</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">createField($name,</span> <span class="pre">$type)</span></tt> returns a <tt class="docutils literal"><span class="pre">FieldBuilder</span></tt> instance</li>
<li><tt class="docutils literal"><span class="pre">createManyToOne($name,</span> <span class="pre">$targetEntity)</span></tt> returns an <tt class="docutils literal"><span class="pre">AssociationBuilder</span></tt> instance</li>
<li><tt class="docutils literal"><span class="pre">createOneToOne($name,</span> <span class="pre">$targetEntity)</span></tt> returns an <tt class="docutils literal"><span class="pre">AssociationBuilder</span></tt> instance</li>
<li><tt class="docutils literal"><span class="pre">createManyToMany($name,</span> <span class="pre">$targetEntity)</span></tt> returns an <tt class="docutils literal"><span class="pre">ManyToManyAssociationBuilder</span></tt> instance</li>
<li><tt class="docutils literal"><span class="pre">createOneToMany($name,</span> <span class="pre">$targetEntity)</span></tt> returns an <tt class="docutils literal"><span class="pre">OneToManyAssociationBuilder</span></tt> instance</li>
</ul>
</div>
<div class="section" id="classmetadatainfo-api">
<h2>23.4. ClassMetadataInfo API<a class="headerlink" href="#classmetadatainfo-api" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="docutils literal"><span class="pre">ClassMetadataInfo</span></tt> class is the base data object for storing
the mapping metadata for a single entity. It contains all the
getters and setters you need populate and retrieve information for
an entity.</p>
<div class="section" id="general-setters">
<h3>23.4.1. General Setters<a class="headerlink" href="#general-setters" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">setTableName($tableName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setPrimaryTable(array</span> <span class="pre">$primaryTableDefinition)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setCustomRepositoryClass($repositoryClassName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setIdGeneratorType($generatorType)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setIdGenerator($generator)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setSequenceGeneratorDefinition(array</span> <span class="pre">$definition)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setChangeTrackingPolicy($policy)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setIdentifier(array</span> <span class="pre">$identifier)</span></tt></li>
</ul>
</div>
<div class="section" id="inheritance-setters">
<h3>23.4.2. Inheritance Setters<a class="headerlink" href="#inheritance-setters" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">setInheritanceType($type)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setSubclasses(array</span> <span class="pre">$subclasses)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setParentClasses(array</span> <span class="pre">$classNames)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setDiscriminatorColumn($columnDef)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setDiscriminatorMap(array</span> <span class="pre">$map)</span></tt></li>
</ul>
</div>
<div class="section" id="field-mapping-setters">
<h3>23.4.3. Field Mapping Setters<a class="headerlink" href="#field-mapping-setters" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">mapField(array</span> <span class="pre">$mapping)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">mapOneToOne(array</span> <span class="pre">$mapping)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">mapOneToMany(array</span> <span class="pre">$mapping)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">mapManyToOne(array</span> <span class="pre">$mapping)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">mapManyToMany(array</span> <span class="pre">$mapping)</span></tt></li>
</ul>
</div>
<div class="section" id="lifecycle-callback-setters">
<h3>23.4.4. Lifecycle Callback Setters<a class="headerlink" href="#lifecycle-callback-setters" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">addLifecycleCallback($callback,</span> <span class="pre">$event)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setLifecycleCallbacks(array</span> <span class="pre">$callbacks)</span></tt></li>
</ul>
</div>
<div class="section" id="versioning-setters">
<h3>23.4.5. Versioning Setters<a class="headerlink" href="#versioning-setters" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">setVersionMapping(array</span> <span class="pre">&$mapping)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setVersioned($bool)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setVersionField()</span></tt></li>
</ul>
</div>
<div class="section" id="general-getters">
<h3>23.4.6. General Getters<a class="headerlink" href="#general-getters" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">getTableName()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getTemporaryIdTableName()</span></tt></li>
</ul>
</div>
<div class="section" id="identifier-getters">
<h3>23.4.7. Identifier Getters<a class="headerlink" href="#identifier-getters" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">getIdentifierColumnNames()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">usesIdGenerator()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isIdentifier($fieldName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isIdGeneratorIdentity()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isIdGeneratorSequence()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isIdGeneratorTable()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isIdentifierNatural()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getIdentifierFieldNames()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getSingleIdentifierFieldName()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getSingleIdentifierColumnName()</span></tt></li>
</ul>
</div>
<div class="section" id="inheritance-getters">
<h3>23.4.8. Inheritance Getters<a class="headerlink" href="#inheritance-getters" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">isInheritanceTypeNone()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isInheritanceTypeJoined()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isInheritanceTypeSingleTable()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isInheritanceTypeTablePerClass()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isInheritedField($fieldName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isInheritedAssociation($fieldName)</span></tt></li>
</ul>
</div>
<div class="section" id="change-tracking-getters">
<h3>23.4.9. Change Tracking Getters<a class="headerlink" href="#change-tracking-getters" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">isChangeTrackingDeferredExplicit()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isChangeTrackingDeferredImplicit()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isChangeTrackingNotify()</span></tt></li>
</ul>
</div>
<div class="section" id="field-association-getters">
<h3>23.4.10. Field & Association Getters<a class="headerlink" href="#field-association-getters" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">isUniqueField($fieldName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isNullable($fieldName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getColumnName($fieldName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getFieldMapping($fieldName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getAssociationMapping($fieldName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getAssociationMappings()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getFieldName($columnName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">hasField($fieldName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getColumnNames(array</span> <span class="pre">$fieldNames</span> <span class="pre">=</span> <span class="pre">null)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getTypeOfField($fieldName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getTypeOfColumn($columnName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">hasAssociation($fieldName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isSingleValuedAssociation($fieldName)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">isCollectionValuedAssociation($fieldName)</span></tt></li>
</ul>
</div>
<div class="section" id="lifecycle-callback-getters">
<h3>23.4.11. Lifecycle Callback Getters<a class="headerlink" href="#lifecycle-callback-getters" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">hasLifecycleCallbacks($lifecycleEvent)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getLifecycleCallbacks($event)</span></tt></li>
</ul>
</div>
</div>
<div class="section" id="classmetadata-api">
<h2>23.5. ClassMetadata API<a class="headerlink" href="#classmetadata-api" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="docutils literal"><span class="pre">ClassMetadata</span></tt> class extends <tt class="docutils literal"><span class="pre">ClassMetadataInfo</span></tt> and adds
the runtime functionality required by Doctrine. It adds a few extra
methods related to runtime reflection for working with the entities
themselves.</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">getReflectionClass()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getReflectionProperties()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getReflectionProperty($name)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getSingleIdReflectionProperty()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getIdentifierValues($entity)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setIdentifierValues($entity,</span> <span class="pre">$id)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setFieldValue($entity,</span> <span class="pre">$field,</span> <span class="pre">$value)</span></tt></li>
<li><tt class="docutils literal"><span class="pre">getFieldValue($entity,</span> <span class="pre">$field)</span></tt></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="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">23. PHP Mapping</a><ul>
<li><a class="reference internal" href="#php-files">23.1. PHP Files</a></li>
<li><a class="reference internal" href="#static-function">23.2. Static Function</a></li>
<li><a class="reference internal" href="#classmetadatabuilder">23.3. ClassMetadataBuilder</a></li>
<li><a class="reference internal" href="#classmetadatainfo-api">23.4. ClassMetadataInfo API</a><ul>
<li><a class="reference internal" href="#general-setters">23.4.1. General Setters</a></li>
<li><a class="reference internal" href="#inheritance-setters">23.4.2. Inheritance Setters</a></li>
<li><a class="reference internal" href="#field-mapping-setters">23.4.3. Field Mapping Setters</a></li>
<li><a class="reference internal" href="#lifecycle-callback-setters">23.4.4. Lifecycle Callback Setters</a></li>
<li><a class="reference internal" href="#versioning-setters">23.4.5. Versioning Setters</a></li>
<li><a class="reference internal" href="#general-getters">23.4.6. General Getters</a></li>
<li><a class="reference internal" href="#identifier-getters">23.4.7. Identifier Getters</a></li>
<li><a class="reference internal" href="#inheritance-getters">23.4.8. Inheritance Getters</a></li>
<li><a class="reference internal" href="#change-tracking-getters">23.4.9. Change Tracking Getters</a></li>
<li><a class="reference internal" href="#field-association-getters">23.4.10. Field & Association Getters</a></li>
<li><a class="reference internal" href="#lifecycle-callback-getters">23.4.11. Lifecycle Callback Getters</a></li>
</ul>
</li>
<li><a class="reference internal" href="#classmetadata-api">23.5. ClassMetadata API</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="annotations-reference.html"
title="previous chapter">22. Annotations Reference</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="caching.html"
title="next chapter">24. Caching</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/reference/php-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>
|