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