1
0
mirror of synced 2024-12-16 16:16:04 +03:00
doctrine2/lib/api/doctrine/common/eventargs.html
2010-04-14 17:13:14 +02:00

122 lines
4.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:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>EventArgs (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/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/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/common/eventargs.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\Common\EventArgs</div>
<div class="location">/Doctrine/Common/EventArgs.php at line 39</div>
<h1>Class EventArgs</h1>
<pre class="tree"><strong>EventArgs</strong><br /></pre>
<hr>
<p class="signature">public class <strong>EventArgs</strong></p>
<div class="comment" id="overview_description"><p>EventArgs is the base class for classes containing event data.</p><p>This class contains no event data. It is used by events that do not pass state
information to an event handler when an event is raised. The single empty EventArgs
instance can be obtained through <code><a href="../../doctrine/common/eventargs.html#getEmptyInstance()">getEmptyInstance</a></code>.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static <a href="../../doctrine/common/eventargs.html">EventArgs</a></td>
<td class="description"><p class="name"><a href="#getEmptyInstance()">getEmptyInstance</a>()</p><p class="description">Gets the single, empty and immutable EventArgs instance.
</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/EventArgs.php at line 61</div>
<h3 id="getEmptyInstance()">getEmptyInstance</h3>
<code class="signature">public static <a href="../../doctrine/common/eventargs.html">EventArgs</a> <strong>getEmptyInstance</strong>()</code>
<div class="details">
<p>Gets the single, empty and immutable EventArgs instance.</p><p>This instance will be used when events are dispatched without any parameter,
like this: EventManager::dispatchEvent('eventname');</p><p>The benefit from this is that only one empty instance is instantiated and shared
(otherwise there would be instances for every dispatched in the abovementioned form)</p><dl>
<dt>See Also:</dt>
<dd>EventManager::dispatchEvent</dd>
<dt>See Also:</dt>
<dd><code><a href="http://msdn.microsoft.com/en-us/library/system.eventargs.aspx">http://msdn.microsoft.com/en-us/library/system.eventargs.aspx</a></code></dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/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/common/eventargs.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>