java/src/messenger/webim/libs/classes/event_dispatcher.php

<?php
/*
 * Copyright 2005-2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Provide event-related functionality.
 * Implements singleton pattern.
 */
Class EventDispatcher {

	/**
	 * An instance of EventDispatcher class.
	 * @var EventDispatcher
	 */
	protected static $instance = null;

	/**
	 * Events and listeners array.
	 * @var array
	 */
	protected $events = array();

	/**
	 * Increments any time when plugin adds. Use for determine plugins order for plugins with
	 * equal priority.
	 * @var int
	 */
	protected $offset = 0;

	/**
	 * Returns an instance of EventDispatcher class.
	 *
	 * @return EventDispatcher
	 */
	public static function getInstance(){
		if (self::$instance === null) {
			self::$instance = new self();
		}
		return self::$instance;
	}

	/**
	 * Make constructor unavailable for client code
	 */
	protected function __constructor() {}

	/**
	 * Attaches listener function to event.
	 *
	 * All event listeners must receive one argument of array type by reference.
	 *
	 * @param string $event_name Event's name
	 * @param Plugin $plugin Plugin object, that handles the event
	 * @param string $listener Plugins method, that handles the event
	 * @param int $priority Priority of listener. If $priority = null, the plugin weight will
	 * use instead.
	 * @return boolean true on success or false on failure.
	 *
	 * @see Plugin::getWeight()
	 */
	public function attachListener($event_name, Plugin $plugin, $listener, $priority = null){
		// Check event exists
		if (! array_key_exists($event_name, $this->events)) {
			trigger_error("Event '{$event_name}' does not exists!", E_USER_WARNING);
			return false;
		}
		// Check method is callable
		if (! is_callable(array($plugin, $listener))) {
			trigger_error("Method '{$listener}' is not callable!", E_USER_WARNING);
			return false;
		}
		// Check priority
		if (is_null($priority)) {
			$priority = $plugin->getWeight();
		}
		// Attach listener
		$this->events[$event_name][$priority . "_" . $this->offset] = array(
			'plugin' => $plugin,
			'listener' => $listener
		);
		$this->offset++;
		return true;
	}

	/**
	 * Detach listener function from event
	 *
	 * @param string $event_name Event's name
	 * @param Plugin $plugin Plugin object, that handles the event
	 * @param string $listener Plugins method, that handles the event
	 * @return boolean true on success or false on failure.
	 */
	public function detachListener($event_name, Plugin $plugin, $listener){
		// Check event exists
		if (! array_key_exists($event_name, $this->events)) {
			trigger_error("Event '{$event_name}' does not exists!", E_USER_WARNING);
			return false;
		}
		// Search event and $plugin->$listener
		foreach ($this->events[$event_name] as $index => $event) {
			if ($event['plugin'] === $plugin && $event['listener'] == $listener) {
				// Detach listener
				unset($this->events[$event_name][$index]);
				return true;
			}
		}
		return false;
	}

	/**
	 * Registers new event
	 *
	 * @param string $event_name Event's name
	 * @return boolean true on success or false on failure
	 */
	public function registerEvent($event_name){
		// Check event exists
		if (array_key_exists($event_name, $this->events)) {
			trigger_error("Event '{$event_name}' already exists!", E_USER_WARNING);
			return false;
		}
		// register event
		$this->events[$event_name] = array();
		return true;
	}

	/**
	 * Triggers the event
	 *
	 * @param string $event_name Event's name
	 * @param array &$arguments Arguments passed to listener
	 * @return boolean true on success or false on failure
	 */
	public function triggerEvent($event_name, &$arguments = array()){
		// Check event exists
		if (! array_key_exists($event_name, $this->events)) {
			trigger_error("Event '{$event_name}' does not exists!", E_USER_WARNING);
			return false;
		}
		// Sorting listeners by priority
		uksort($this->events[$event_name], 'strnatcmp');
		// Invoke listeners
		foreach ($this->events[$event_name] as $event) {
			$plugin = $event['plugin'];
			$listener = $event['listener'];
			$plugin->$listener($arguments);
		}
	}

}

?>