aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2015-11-20 06:45:11 +0100
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2015-11-23 21:26:33 +0100
commit31f44570b8d928ba29ddfc56e7bc0d1f2a1c745a (patch)
tree47123689ae286471a6020e07408b16306d369858
parentb34745e1506dc59f293776d5b0be6d4d45672ae9 (diff)
downloadEvent-31f44570b8d928ba29ddfc56e7bc0d1f2a1c745a.zip
Event-31f44570b8d928ba29ddfc56e7bc0d1f2a1c745a.tar.gz
Event-31f44570b8d928ba29ddfc56e7bc0d1f2a1c745a.tar.bz2
Listener: Add the `Listens` trait.
This trait is an implementation of the `Listenable` interface (with the `on` method). We add `getListener` and `setListener` for more convinience.
-rw-r--r--Listens.php106
1 files changed, 106 insertions, 0 deletions
diff --git a/Listens.php b/Listens.php
new file mode 100644
index 0000000..23e363c
--- /dev/null
+++ b/Listens.php
@@ -0,0 +1,106 @@
+<?php
+
+/**
+ * Hoa
+ *
+ *
+ * @license
+ *
+ * New BSD License
+ *
+ * Copyright © 2007-2015, Hoa community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of the Hoa nor the names of its contributors may be
+ * used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+namespace Hoa\Event;
+
+/**
+ * Trait \Hoa\Event\Listens.
+ *
+ * Implementation of a listener.
+ *
+ * @copyright Copyright © 2007-2015 Hoa community
+ * @license New BSD License
+ */
+trait Listens
+{
+ /**
+ * Listener instance.
+ *
+ * @var \Hoa\Event\Listener
+ */
+ protected $_listener = null;
+
+
+
+ /**
+ * Attach a callable to a listenable component.
+ *
+ * @param string $listenerId Listener ID.
+ * @param mixed $callable Callable.
+ * @return \Hoa\Event\Listenable
+ */
+ public function on($listenerId, $callable)
+ {
+ $listener = $this->getListener();
+
+ if (null === $listener) {
+ throw new Exception(
+ 'Cannot attach a callable to the listener %s because ' .
+ 'it has not been initialized yet.',
+ 0,
+ get_class($this)
+ );
+ }
+
+ $listener->attach($listenerId, $callable);
+
+ return $this;
+ }
+
+ /**
+ * Set listener.
+ *
+ * @param \Hoa\Event\Listener $listener Listener.
+ * @return \Hoa\Event\Listener
+ */
+ protected function setListener(Listener $listener)
+ {
+ $old = $this->_listener;
+ $this->_listener = $listener;
+
+ return $old;
+ }
+
+ /**
+ * Get listener.
+ *
+ * @return \Hoa\Event\Listener
+ */
+ protected function getListener()
+ {
+ return $this->_listener;
+ }
+}