1: <?php
 2: /**
 3:  *
 4:  * PHP 5
 5:  *
 6:  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 7:  * Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
 8:  *
 9:  * Licensed under The MIT License
10:  * Redistributions of files must retain the above copyright notice.
11:  *
12:  * @copyright     Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
13:  * @link          http://cakephp.org CakePHP(tm) Project
14:  * @package       Cake.Observer
15:  * @since         CakePHP(tm) v 2.1
16:  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
17:  */
18: 
19: /**
20:  * Objects implementing this interface should declare the `implementedEvents` function
21:  * to hint the event manager what methods should be called when an event is triggered.
22:  *
23:  * @package Cake.Event
24:  */
25: interface CakeEventListener  {
26: 
27: /**
28:  * Returns a list of events this object is implementing, when the class is registered
29:  * in an event manager, each individual method will be associated to the respective event.
30:  *
31:  * ## Example:
32:  *
33:  * {{{
34:  *  public function implementedEvents() {
35:  *      return array(
36:  *          'Order.complete' => 'sendEmail',
37:  *          'Article.afterBuy' => 'decrementInventory',
38:  *          'User.onRegister' => array('callable' => 'logRegistration', 'priority' => 20, 'passParams' => true)
39:  *      );
40:  *  }
41:  * }}}
42:  *
43:  * @return array associative array or event key names pointing to the function
44:  * that should be called in the object when the respective event is fired
45:  */
46:     public function implementedEvents();
47: 
48: }
49: