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: * @since 2.1.0
13: * @license https://opensource.org/licenses/mit-license.php MIT License
14: */
15: namespace Cake\Event;
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: interface EventListenerInterface
22: {
23: /**
24: * Returns a list of events this object is implementing. When the class is registered
25: * in an event manager, each individual method will be associated with the respective event.
26: *
27: * ### Example:
28: *
29: * ```
30: * public function implementedEvents()
31: * {
32: * return [
33: * 'Order.complete' => 'sendEmail',
34: * 'Article.afterBuy' => 'decrementInventory',
35: * 'User.onRegister' => ['callable' => 'logRegistration', 'priority' => 20, 'passParams' => true]
36: * ];
37: * }
38: * ```
39: *
40: * @return array Associative array or event key names pointing to the function
41: * that should be called in the object when the respective event is fired
42: */
43: public function implementedEvents();
44: }
45: