phpdoc/Library/Event/EventManagerExtended.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\Event\EventManagerExtended | Library</title>
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../../css/sami.css">
<script src="../../js/jquery-1.11.1.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script src="../../js/typeahead.min.js"></script>
<script src="../../sami.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="class" data-name="class:Library_Event_EventManagerExtended" data-root-path="../../">
<div id="content">
<div id="left-column">
<div id="control-panel">
<form id="search-form" action="../../search.html" method="GET">
<span class="glyphicon glyphicon-search"></span>
<input name="search"
class="typeahead form-control"
type="search"
placeholder="Search">
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">Library</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../traits.html">Traits</a></li>
<li><a href="../../doc-index.html">Index</a></li>
<li><a href="../../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../../Library.html">Library</a></li>
<li><a href="../../Library/Event.html">Event</a></li>
<li>EventManagerExtended</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>EventManagerExtended</h1>
</div>
<p> class
<strong>EventManagerExtended</strong> extends <a href="../../Library/Event/EventManager.html"><abbr title="Library\Event\EventManager">EventManager</abbr></a>
</p>
<div class="description">
<p>Class EventManagerExtended</p> <p>This only defines aliases to use event handling with facilities:</p>
<pre><code> $eventManager
->listen ( event , callback )
->stopListen ( event , callback )
->subscribe ( event , subscriber )
->stopSubscribe ( event , subscriber )
->on ( event , callback )
->off ( event , callback )
->trigger ( event , subject )
</code></pre>
<p>All aliases return the object itself for method chaining and
will throw any caught exception.</p> </div>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method___construct">__construct</a>()
<p>Initialize the observers storage registry</p> </div>
<div class="col-md-2"><small>from
<a href="../../Library/Event/EventManager.html#method___construct"><abbr title="Library\Event\EventManager">EventManager</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_addListener">addListener</a>($event, $callback)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"><small>from
<a href="../../Library/Event/EventManager.html#method_addListener"><abbr title="Library\Event\EventManager">EventManager</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_removeListener">removeListener</a>($event, $callback)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"><small>from
<a href="../../Library/Event/EventManager.html#method_removeListener"><abbr title="Library\Event\EventManager">EventManager</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_hasListeners">hasListeners</a>($event)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"><small>from
<a href="../../Library/Event/EventManager.html#method_hasListeners"><abbr title="Library\Event\EventManager">EventManager</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
array|null
</div>
<div class="col-md-8 type">
<a href="#method_getListeners">getListeners</a>($event)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"><small>from
<a href="../../Library/Event/EventManager.html#method_getListeners"><abbr title="Library\Event\EventManager">EventManager</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_addSubscriber">addSubscriber</a>(
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr> $subscriber)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"><small>from
<a href="../../Library/Event/EventManager.html#method_addSubscriber"><abbr title="Library\Event\EventManager">EventManager</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_removeSubscriber">removeSubscriber</a>(
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr> $subscriber)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"><small>from
<a href="../../Library/Event/EventManager.html#method_removeSubscriber"><abbr title="Library\Event\EventManager">EventManager</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
mixed
</div>
<div class="col-md-8 type">
<a href="#method_triggerEvent">triggerEvent</a>(
string $event_name,
<abbr title="Library\Event\Library\Event\ObservableInterface">ObservableInterface</abbr> $subject)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"><small>from
<a href="../../Library/Event/EventManager.html#method_triggerEvent"><abbr title="Library\Event\EventManager">EventManager</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\Event\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_listen">listen</a>($event, $callback)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\Event\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_stopListen">stopListen</a>($event, $callback)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\Event\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_subscribe">subscribe</a>(
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr> $subscriber)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\Event\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_stopSubscribe">stopSubscribe</a>(
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr> $subscriber)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\Event\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_on">on</a>($event, $callback)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\Event\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_off">off</a>($event, $callback)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\Event\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_trigger">trigger</a>(
string $event,
<abbr title="Library\Event\Library\Event\ObservableInterface">ObservableInterface</abbr> $subject)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method___construct">
<div class="location">in
<a href="../../Library/Event/EventManager.html#method___construct"><abbr title="Library\Event\EventManager">EventManager</abbr></a> at line 47</div>
<code>
<strong>__construct</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Initialize the observers storage registry</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_addListener">
<div class="location">in
<a href="../../Library/Event/EventManager.html#method_addListener"><abbr title="Library\Event\EventManager">EventManager</abbr></a> at line 58</div>
<code>
<strong>addListener</strong>($event, $callback)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$event</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$callback</td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_removeListener">
<div class="location">in
<a href="../../Library/Event/EventManager.html#method_removeListener"><abbr title="Library\Event\EventManager">EventManager</abbr></a> at line 73</div>
<code>
<strong>removeListener</strong>($event, $callback)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$event</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$callback</td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_hasListeners">
<div class="location">in
<a href="../../Library/Event/EventManager.html#method_hasListeners"><abbr title="Library\Event\EventManager">EventManager</abbr></a> at line 85</div>
<code>
bool
<strong>hasListeners</strong>($event)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$event</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getListeners">
<div class="location">in
<a href="../../Library/Event/EventManager.html#method_getListeners"><abbr title="Library\Event\EventManager">EventManager</abbr></a> at line 94</div>
<code>
array|null
<strong>getListeners</strong>($event)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$event</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array|null</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_addSubscriber">
<div class="location">in
<a href="../../Library/Event/EventManager.html#method_addSubscriber"><abbr title="Library\Event\EventManager">EventManager</abbr></a> at line 107</div>
<code>
<strong>addSubscriber</strong>(
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr> $subscriber)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr></td>
<td>$subscriber</td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_removeSubscriber">
<div class="location">in
<a href="../../Library/Event/EventManager.html#method_removeSubscriber"><abbr title="Library\Event\EventManager">EventManager</abbr></a> at line 125</div>
<code>
<strong>removeSubscriber</strong>(
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr> $subscriber)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr></td>
<td>$subscriber</td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_triggerEvent">
<div class="location">in
<a href="../../Library/Event/EventManager.html#method_triggerEvent"><abbr title="Library\Event\EventManager">EventManager</abbr></a> at line 143</div>
<code>
mixed
<strong>triggerEvent</strong>(
string $event_name,
<abbr title="Library\Event\Library\Event\ObservableInterface">ObservableInterface</abbr> $subject)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$event_name</td>
<td>
</td>
</tr>
<tr>
<td>
<abbr title="Library\Event\Library\Event\ObservableInterface">ObservableInterface</abbr></td>
<td>$subject</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_listen">
<div class="location">at line 62</div>
<code>
<abbr title="Library\Event\$this">$this</abbr>
<strong>listen</strong>($event, $callback)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$event</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$callback</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Event\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_stopListen">
<div class="location">at line 78</div>
<code>
<abbr title="Library\Event\$this">$this</abbr>
<strong>stopListen</strong>($event, $callback)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$event</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$callback</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Event\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_subscribe">
<div class="location">at line 93</div>
<code>
<abbr title="Library\Event\$this">$this</abbr>
<strong>subscribe</strong>(
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr> $subscriber)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr></td>
<td>$subscriber</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Event\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_stopSubscribe">
<div class="location">at line 108</div>
<code>
<abbr title="Library\Event\$this">$this</abbr>
<strong>stopSubscribe</strong>(
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr> $subscriber)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Event\Library\Event\EventSubscriberInterface">EventSubscriberInterface</abbr></td>
<td>$subscriber</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Event\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_on">
<div class="location">at line 124</div>
<code>
<abbr title="Library\Event\$this">$this</abbr>
<strong>on</strong>($event, $callback)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$event</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$callback</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Event\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_off">
<div class="location">at line 140</div>
<code>
<abbr title="Library\Event\$this">$this</abbr>
<strong>off</strong>($event, $callback)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$event</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$callback</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Event\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_trigger">
<div class="location">at line 156</div>
<code>
<abbr title="Library\Event\$this">$this</abbr>
<strong>trigger</strong>(
string $event,
<abbr title="Library\Event\Library\Event\ObservableInterface">ObservableInterface</abbr> $subject)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$event</td>
<td>
</td>
</tr>
<tr>
<td>
<abbr title="Library\Event\Library\Event\ObservableInterface">ObservableInterface</abbr></td>
<td>$subject</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Event\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
</div>
</div>
</div>
</body>
</html>