1
0
mirror of synced 2024-12-15 07:36:03 +03:00
doctrine2/lib/api/doctrine/orm/events.html
2010-04-14 17:13:14 +02:00

245 lines
9.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:04 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>Events (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/orm/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/orm/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/orm/events.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\ORM\Events</div>
<div class="location">/Doctrine/ORM/Events.php at line 32</div>
<h1>Class Events</h1>
<pre class="tree"><strong>Events</strong><br /></pre>
<hr>
<p class="signature">public final class <strong>Events</strong></p>
<div class="comment" id="overview_description"><p>Container for all ORM events.</p><p>This class cannot be instantiated.</p></div>
<dl>
<dt>Author:</dt>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dt>Since:</dt>
<dd>2.0</dd>
</dl>
<hr>
<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type">final string</td>
<td class="description"><p class="name"><a href="#loadClassMetadata">loadClassMetadata</a></p><p class="description">The loadClassMetadata event occurs after the mapping metadata for a class
has been loaded from a mapping source (annotations/xml/yaml).</p></td>
</tr>
<tr>
<td class="type">final string</td>
<td class="description"><p class="name"><a href="#onFlush">onFlush</a></p><p class="description">The onFlush event occurs when the EntityManager#flush() operation is invoked,
after any changes to managed entities have been determined but before any
actual database operations are executed. </p></td>
</tr>
<tr>
<td class="type">final string</td>
<td class="description"><p class="name"><a href="#postLoad">postLoad</a></p><p class="description">The postLoad event occurs for an entity after the entity has been loaded
into the current EntityManager from the database or after the refresh operation
has been applied to it.
</p></td>
</tr>
<tr>
<td class="type">final string</td>
<td class="description"><p class="name"><a href="#postPersist">postPersist</a></p><p class="description">The postPersist event occurs for an entity after the entity has
been made persistent. </p></td>
</tr>
<tr>
<td class="type">final string</td>
<td class="description"><p class="name"><a href="#postRemove">postRemove</a></p><p class="description">The postRemove event occurs for an entity after the entity has
been deleted. </p></td>
</tr>
<tr>
<td class="type">final string</td>
<td class="description"><p class="name"><a href="#postUpdate">postUpdate</a></p><p class="description">The postUpdate event occurs after the database update operations to
entity data. </p></td>
</tr>
<tr>
<td class="type">final string</td>
<td class="description"><p class="name"><a href="#prePersist">prePersist</a></p><p class="description">The prePersist event occurs for a given entity before the respective
EntityManager persist operation for that entity is executed.
</p></td>
</tr>
<tr>
<td class="type">final string</td>
<td class="description"><p class="name"><a href="#preRemove">preRemove</a></p><p class="description">The preRemove event occurs for a given entity before the respective
EntityManager remove operation for that entity is executed.
</p></td>
</tr>
<tr>
<td class="type">final string</td>
<td class="description"><p class="name"><a href="#preUpdate">preUpdate</a></p><p class="description">The preUpdate event occurs before the database update operations to
entity data. </p></td>
</tr>
</table>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#Events()">Events</a>()</p></td>
</tr>
</table>
<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/ORM/Events.php at line 110</div>
<h3 id="loadClassMetadata">loadClassMetadata</h3>
<code class="signature">public final string <strong>loadClassMetadata</strong> = 'loadClassMetadata'</code>
<div class="details">
<p>The loadClassMetadata event occurs after the mapping metadata for a class
has been loaded from a mapping source (annotations/xml/yaml).</p></div>
<hr>
<div class="location">/Doctrine/ORM/Events.php at line 121</div>
<h3 id="onFlush">onFlush</h3>
<code class="signature">public final string <strong>onFlush</strong> = 'onFlush'</code>
<div class="details">
<p>The onFlush event occurs when the EntityManager#flush() operation is invoked,
after any changes to managed entities have been determined but before any
actual database operations are executed. The event is only raised if there is
actually something to do for the underlying UnitOfWork. If nothing needs to be done,
the onFlush event is not raised.</p></div>
<hr>
<div class="location">/Doctrine/ORM/Events.php at line 103</div>
<h3 id="postLoad">postLoad</h3>
<code class="signature">public final string <strong>postLoad</strong> = 'postLoad'</code>
<div class="details">
<p>The postLoad event occurs for an entity after the entity has been loaded
into the current EntityManager from the database or after the refresh operation
has been applied to it.</p><p>Note that the postLoad event occurs for an entity before any associations have been
initialized. Therefore it is not safe to access associations in a postLoad callback
or event handler.</p><p>This is an entity lifecycle event.</p></div>
<hr>
<div class="location">/Doctrine/ORM/Events.php at line 71</div>
<h3 id="postPersist">postPersist</h3>
<code class="signature">public final string <strong>postPersist</strong> = 'postPersist'</code>
<div class="details">
<p>The postPersist event occurs for an entity after the entity has
been made persistent. It will be invoked after the database insert operations.
Generated primary key values are available in the postPersist event.</p><p>This is an entity lifecycle event.</p></div>
<hr>
<div class="location">/Doctrine/ORM/Events.php at line 52</div>
<h3 id="postRemove">postRemove</h3>
<code class="signature">public final string <strong>postRemove</strong> = 'postRemove'</code>
<div class="details">
<p>The postRemove event occurs for an entity after the entity has
been deleted. It will be invoked after the database delete operations.</p><p>This is an entity lifecycle event.</p></div>
<hr>
<div class="location">/Doctrine/ORM/Events.php at line 89</div>
<h3 id="postUpdate">postUpdate</h3>
<code class="signature">public final string <strong>postUpdate</strong> = 'postUpdate'</code>
<div class="details">
<p>The postUpdate event occurs after the database update operations to
entity data. </p><p>This is an entity lifecycle event.</p></div>
<hr>
<div class="location">/Doctrine/ORM/Events.php at line 61</div>
<h3 id="prePersist">prePersist</h3>
<code class="signature">public final string <strong>prePersist</strong> = 'prePersist'</code>
<div class="details">
<p>The prePersist event occurs for a given entity before the respective
EntityManager persist operation for that entity is executed.</p><p>This is an entity lifecycle event.</p></div>
<hr>
<div class="location">/Doctrine/ORM/Events.php at line 43</div>
<h3 id="preRemove">preRemove</h3>
<code class="signature">public final string <strong>preRemove</strong> = 'preRemove'</code>
<div class="details">
<p>The preRemove event occurs for a given entity before the respective
EntityManager remove operation for that entity is executed.</p><p>This is an entity lifecycle event.</p></div>
<hr>
<div class="location">/Doctrine/ORM/Events.php at line 80</div>
<h3 id="preUpdate">preUpdate</h3>
<code class="signature">public final string <strong>preUpdate</strong> = 'preUpdate'</code>
<div class="details">
<p>The preUpdate event occurs before the database update operations to
entity data. </p><p>This is an entity lifecycle event.</p></div>
<hr>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/ORM/Events.php at line 34</div>
<h3 id="Events()">Events</h3>
<code class="signature">public <strong>Events</strong>()</code>
<div class="details">
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/orm/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/orm/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/orm/events.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>