-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathEventManagerInterface.php
More file actions
115 lines (110 loc) · 3.7 KB
/
Copy pathEventManagerInterface.php
File metadata and controls
115 lines (110 loc) · 3.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.6.0
* @license https://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Event;
/**
* Interface EventManagerInterface
*/
interface EventManagerInterface
{
/**
* Adds a new listener to an event.
*
* Binding an EventListenerInterface:
*
* ```
* $eventManager->on($listener);
* ```
*
* Binding with no options:
*
* ```
* $eventManager->on('Model.beforeSave', $callable);
* ```
*
* Binding with options:
*
* ```
* $eventManager->on('Model.beforeSave', $callable, ['priority' => 90]);
* ```
*
* @param \Cake\Event\EventListenerInterface|string $eventKey The event unique identifier name
* with which the callback will be associated. If $eventKey is an instance of
* Cake\Event\EventListenerInterface its events will be bound using the `implementedEvents()` methods.
* @param callable|null $callable The callable function you want invoked.
* @param array $options An array of options, the `priority` key can be used to define the order.
* Priorities are treated as queues. Lower values are called before higher ones, and multiple attachments
* added to the same priority queue will be treated in the order of insertion.
* @return $this
* @throws \InvalidArgumentException When event key is missing or callable is not an
* instance of Cake\Event\EventListenerInterface.
*/
public function on(
EventListenerInterface|string $eventKey,
?callable $callable = null,
array $options = [],
): static;
/**
* Remove a listener from the active listeners.
*
* Remove a EventListenerInterface entirely:
*
* ```
* $manager->off($listener);
* ```
*
* Remove all listeners for a given event:
*
* ```
* $manager->off('My.event');
* ```
*
* Remove a specific listener:
*
* ```
* $manager->off('My.event', $callback);
* ```
*
* Remove a callback from all events:
*
* ```
* $manager->off($callback);
* ```
*
* @param \Cake\Event\EventListenerInterface|callable|string $eventKey The event unique identifier name
* with which the callback has been associated, or the $listener you want to remove.
* @param \Cake\Event\EventListenerInterface|callable|null $callable The callback you want to detach.
* @return $this
*/
public function off(
EventListenerInterface|callable|string $eventKey,
EventListenerInterface|callable|null $callable = null,
): static;
/**
* Dispatches a new event to all configured listeners
*
* @template TSubject of object
* @param \Cake\Event\EventInterface<TSubject>|string $event The event key name or instance of EventInterface.
* @return \Cake\Event\EventInterface<TSubject>
* @triggers $event
*/
public function dispatch(EventInterface|string $event): EventInterface;
/**
* Returns a list of all listeners for an eventKey in the order they should be called
*
* @param string $eventKey Event key.
* @return array
*/
public function listeners(string $eventKey): array;
}