[Kohana] Klasa Event's Opcje

[by_ikar]

Ostatnim czasy trochę analizuje kod frameworka kohana, przy okazji ucząc się oop, generalnie ucząc się do czego można go wykorzystać. Kilka rzeczy rozumiem, ale jest sporo których nie rozumiem. Jedną z tych rzeczy jest klasa Event, która z tego co rozumiem, "uruchamia" metody klas. Przykładowo w pliku bootstrap.php znajduje się coś takiego:

[PHP] pobierz, plaintext 
Event::run('system.shutdown');
[PHP] pobierz, plaintext 

Natomiast w pliku kohana.php (główny plik, "rdzenie" enignu) znajduje się taki kod:

[PHP] pobierz, plaintext 
Event::add('system.shutdown', array('Kohana', 'shutdown'));
[PHP] pobierz, plaintext 

drugi parametr, który jest tablicą, kohana - nazwa "głównej klasy, shutdown - nazwa metody.

Teraz moje pytanie, jakie płyną korzyści z zastosowania klasy event, oraz czy dobrze rozumuje, że na takiej zasadzie na jakiej to opisałem, działa?
Strona dokumentacji: http://docs.kohanaphp.com/core/event mówi mi tylko tyle jak tego używać, ale jakie jest założenie używania tego, nie bardzo mi to uświadamia. Jeżeli znalazłby się ktoś kto mógłby mi to w skrócie opisać, nawet łopatologicznie - po wała korzystać z klasy event, to byłbym bardzo wdzięczny (IMG:style_emoticons/default/smile.gif)

PS nie krzyczcie na mnie że głupi jestem - ja to wiem (IMG:style_emoticons/default/smile.gif) więc fajnie będzie jak ktoś pomoże mi przestać być głupim. Poniżej również załączam klasę event, dla nie siedzących w temacie, lub leniwych ;P

Pozdrawiam, filip.

[PHP] pobierz, plaintext 
<?php defined('SYSPATH') OR die('No direct access allowed.');
/**
 * Process queuing/execution class. Allows an unlimited number of callbacks
 * to be added to 'events'. Events can be run multiple times, and can also
 * process event-specific data. By default, Kohana has several system events.
 *
 * $Id: Event.php 4390 2009-06-04 03:05:36Z zombor $
 *
 * @package    Core
 * @author     Kohana Team
 * @copyright  (c) 2007 Kohana Team
 * @license    <a href="http://kohanaphp.com/license.html" target="_blank">http://kohanaphp.com/license.html</a>
 * @link       <a href="http://docs.kohanaphp.com/general/events" target="_blank">http://docs.kohanaphp.com/general/events</a>
 */
final class Event {
 
	// Event callbacks
	private static $events = array();
 
	// Cache of events that have been run
	private static $has_run = array();
 
	// Data that can be processed during events
	public static $data;
 
	/**
	 * Add a callback to an event queue.
	 *
	 * @param   string   event name
	 * @param   array    <a href="http://php.net/callback" target="_blank">http://php.net/callback</a>
	 * @return  boolean
	 */
	public static function add($name, $callback)
	{
		if ( ! isset(self::$events[$name]))
		{
			// Create an empty event if it is not yet defined
			self::$events[$name] = array();
		}
		elseif (in_array($callback, self::$events[$name], TRUE))
		{
			// The event already exists
			return FALSE;
		}
 
		// Add the event
		self::$events[$name][] = $callback;
 
		return TRUE;
	}
 
	/**
	 * Add a callback to an event queue, before a given event.
	 *
	 * @param   string   event name
	 * @param   array    existing event callback
	 * @param   array    event callback
	 * @return  boolean
	 */
	public static function add_before($name, $existing, $callback)
	{
		if (empty(self::$events[$name]) OR ($key = array_search($existing, self::$events[$name])) === FALSE)
		{
			// Just add the event if there are no events
			return self::add($name, $callback);
		}
		else
		{
			// Insert the event immediately before the existing event
			return self::insert_event($name, $key, $callback);
		}
	}
 
	/**
	 * Add a callback to an event queue, after a given event.
	 *
	 * @param   string   event name
	 * @param   array    existing event callback
	 * @param   array    event callback
	 * @return  boolean
	 */
	public static function add_after($name, $existing, $callback)
	{
		if (empty(self::$events[$name]) OR ($key = array_search($existing, self::$events[$name])) === FALSE)
		{
			// Just add the event if there are no events
			return self::add($name, $callback);
		}
		else
		{
			// Insert the event immediately after the existing event
			return self::insert_event($name, $key + 1, $callback);
		}
	}
 
	/**
	 * Inserts a new event at a specfic key location.
	 *
	 * @param   string   event name
	 * @param   integer  key to insert new event at
	 * @param   array    event callback
	 * @return  void
	 */
	private static function insert_event($name, $key, $callback)
	{
		if (in_array($callback, self::$events[$name], TRUE))
			return FALSE;
 
		// Add the new event at the given key location
		self::$events[$name] = array_merge
		(
			// Events before the key
			array_slice(self::$events[$name], 0, $key),
			// New event callback
			array($callback),
			// Events after the key
			array_slice(self::$events[$name], $key)
		);
 
		return TRUE;
	}
 
	/**
	 * Replaces an event with another event.
	 *
	 * @param   string   event name
	 * @param   array    event to replace
	 * @param   array    new callback
	 * @return  boolean
	 */
	public static function replace($name, $existing, $callback)
	{
		if (empty(self::$events[$name]) OR ($key = array_search($existing, self::$events[$name], TRUE)) === FALSE)
			return FALSE;
 
		if ( ! in_array($callback, self::$events[$name], TRUE))
		{
			// Replace the exisiting event with the new event
			self::$events[$name][$key] = $callback;
		}
		else
		{
			// Remove the existing event from the queue
			unset(self::$events[$name][$key]);
 
			// Reset the array so the keys are ordered properly
			self::$events[$name] = array_values(self::$events[$name]);
		}
 
		return TRUE;
	}
 
	/**
	 * Get all callbacks for an event.
	 *
	 * @param   string  event name
	 * @return  array
	 */
	public static function get($name)
	{
		return empty(self::$events[$name]) ? array() : self::$events[$name];
	}
 
	/**
	 * Clear some or all callbacks from an event.
	 *
	 * @param   string  event name
	 * @param   array   specific callback to remove, FALSE for all callbacks
	 * @return  void
	 */
	public static function clear($name, $callback = FALSE)
	{
		if ($callback === FALSE)
		{
			self::$events[$name] = array();
		}
		elseif (isset(self::$events[$name]))
		{
			// Loop through each of the event callbacks and compare it to the
			// callback requested for removal. The callback is removed if it
			// matches.
			foreach (self::$events[$name] as $i => $event_callback)
			{
				if ($callback === $event_callback)
				{
					unset(self::$events[$name][$i]);
				}
			}
		}
	}
 
	/**
	 * Execute all of the callbacks attached to an event.
	 *
	 * @param   string   event name
	 * @param   array    data can be processed as Event::$data by the callbacks
	 * @return  void
	 */
	public static function run($name, & $data = NULL)
	{
		if ( ! empty(self::$events[$name]))
		{
			// So callbacks can access Event::$data
			self::$data =& $data;
			$callbacks  =  self::get($name);
 
			foreach ($callbacks as $callback)
			{
				call_user_func($callback);
			}
 
			// Do this to prevent data from getting 'stuck'
			$clear_data = '';
			self::$data =& $clear_data;
		}
 
		// The event has been run!
		self::$has_run[$name] = $name;
	}
 
	/**
	 * Check if a given event has been run.
	 *
	 * @param   string   event name
	 * @return  boolean
	 */
	public static function has_run($name)
	{
		return isset(self::$has_run[$name]);
	}
 
} // End Event
[PHP] pobierz, plaintext 

[phpion]

Najlepiej będzie Ci to chyba zrozumieć na przykładzie zdarzenia system.404. Zdarzenie to uruchamiasz w ten sposób:

[PHP] pobierz, plaintext 
Event::run('system.404');
[PHP] pobierz, plaintext 

Wyświetla ono widok braku strony. Teraz np. w kontrolerze pobierasz dane na podstawie ID. Jeżeli dane zostały znalezione to spoko, wyświetlasz je w widoku. Jeśli nie (np. gdy ktoś ręcznie podmienił ID w adresie) to możesz wyświetlić widok braku strony uruchamiając właśnie wspomniany event.

W skrócie: są to jakby zdefiniowane zdarzenia, które mogą zajść w systemie. Mechanizm eventów jest tak naprawdę bardzo przydatny, nie tylko w celu uproszczenia kodu (mógłbyś przecież ręcznie podstawić widok braku strony). Ja np. zaraz po przejściu routingu uruchamiam event, który sprawdza, czy użytkownik ma prawa do danej strony:

[PHP] pobierz, plaintext 
Event::add('system.routing', array('ACL_Hook', 'check'));
[PHP] pobierz, plaintext 

Przed tym jednak sprawdzam, czy użytkownik jest zalogowany:

[PHP] pobierz, plaintext 
Event::add_before('system.routing', array('ACL_Hook', 'check'), array('Auth_Hook', 'check'));
[PHP] pobierz, plaintext 

czyli dodaję nowy event przed sprawdzeniem uprawnień. Oto kod tej metody:

[PHP] pobierz, plaintext 
/**
 * Sprawdza czy akcja wymaga uwierzytelnienia oraz czy użytkownik jest uwierzytelniony.
 * 
 * Jeżeli akcja wymaga uwierzytelnienia, a użytkownik nie jest uwierzytelniony
 * uruchamia event o konieczności zalogowania.
 */
public function check() {
	Kohana::log('info', 'Auth_Hook::check() run');
 
	if (Structure::instance()->is_authentication_required() && !Auth::instance()->is_user_authenticated()) {
		Event::run('system.401');
	}
}
[PHP] pobierz, plaintext 

I tu znowu pojawia się event. Jeśli strona wymaga uwierzytelnienia, a użytkownik nie jest zalogowany to wyświetlam mu stronę z formularzem logowania, czyli uruchamiam mój event system.401.

[by_ikar]

Odpowiedź szybka prawie jak w komunikatorze (IMG:style_emoticons/default/biggrin.gif) dziękować panowie. Tak jak mniej więcej myślałem. Tyle że nie sądziłem, że można zrobić to nawet tak:

[PHP] pobierz, plaintext 
Event::add_before('system.routing', array('ACL_Hook', 'check'), array('Auth_Hook', 'check'));
[PHP] pobierz, plaintext 

Bo w ten sposób to znacznie poszerza zastosowanie event'a. Teraz dostrzegam wiele miejsc w których można skrócić event'em wiele kodu (IMG:style_emoticons/default/biggrin.gif)

Dzięki jeszcze raz za wytłumaczenie (IMG:style_emoticons/default/smile.gif)