diff options
Diffstat (limited to 'vendor/sabre/event/lib/EmitterInterface.php')
-rw-r--r-- | vendor/sabre/event/lib/EmitterInterface.php | 31 |
1 files changed, 18 insertions, 13 deletions
diff --git a/vendor/sabre/event/lib/EmitterInterface.php b/vendor/sabre/event/lib/EmitterInterface.php index 6ce0f34db..a7e4b6132 100644 --- a/vendor/sabre/event/lib/EmitterInterface.php +++ b/vendor/sabre/event/lib/EmitterInterface.php @@ -1,11 +1,9 @@ -<?php - -declare(strict_types=1); +<?php declare (strict_types=1); namespace Sabre\Event; /** - * Event Emitter Interface. + * Event Emitter Interface * * Anything that accepts listeners and emits events should implement this * interface. @@ -14,22 +12,26 @@ namespace Sabre\Event; * @author Evert Pot (http://evertpot.com/) * @license http://sabre.io/license/ Modified BSD License */ -interface EmitterInterface -{ +interface EmitterInterface { + /** * Subscribe to an event. + * + * @return void */ - public function on(string $eventName, callable $callBack, int $priority = 100); + function on(string $eventName, callable $callBack, int $priority = 100); /** * Subscribe to an event exactly once. + * + * @return void */ - public function once(string $eventName, callable $callBack, int $priority = 100); + function once(string $eventName, callable $callBack, int $priority = 100); /** * Emits an event. * - * This method will return true if 0 or more listeners were successfully + * This method will return true if 0 or more listeners were succesfully * handled. false is returned if one of the events broke the event chain. * * If the continueCallBack is specified, this callback will be called every @@ -47,7 +49,7 @@ interface EmitterInterface * Lastly, if there are 5 event handlers for an event. The continueCallback * will be called at most 4 times. */ - public function emit(string $eventName, array $arguments = [], callable $continueCallBack = null): bool; + function emit(string $eventName, array $arguments = [], callable $continueCallBack = null) : bool; /** * Returns the list of listeners for an event. @@ -57,7 +59,7 @@ interface EmitterInterface * * @return callable[] */ - public function listeners(string $eventName): array; + function listeners(string $eventName) : array; /** * Removes a specific listener from an event. @@ -65,7 +67,7 @@ interface EmitterInterface * If the listener could not be found, this method will return false. If it * was removed it will return true. */ - public function removeListener(string $eventName, callable $listener): bool; + function removeListener(string $eventName, callable $listener) : bool; /** * Removes all listeners. @@ -73,6 +75,9 @@ interface EmitterInterface * If the eventName argument is specified, all listeners for that event are * removed. If it is not specified, every listener for every event is * removed. + * + * @return void */ - public function removeAllListeners(string $eventName = null); + function removeAllListeners(string $eventName = null); + } |