summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2021-01-15 09:46:37 +0100
committerGitHub <noreply@github.com>2021-01-15 09:46:37 +0100
commitbcb52d64f0838030e70bbc3b1f652e239f17904d (patch)
tree3c71fe1489f11dcac667e2bf8a81362b91ce28d2 /lib
parentc80e007607ebffd6e1c6f2b2b02df049ba4575ff (diff)
parentb8acf2fe69a856511e004a512e2168ac6990c87a (diff)
downloadnextcloud-server-bcb52d64f0838030e70bbc3b1f652e239f17904d.tar.gz
nextcloud-server-bcb52d64f0838030e70bbc3b1f652e239f17904d.zip
Merge pull request #25141 from nextcloud/bugfix/noid/add-a-hint-about-priority
Add a hint about the direction of priority
Diffstat (limited to 'lib')
-rw-r--r--lib/public/AppFramework/Bootstrap/IRegistrationContext.php3
-rw-r--r--lib/public/EventDispatcher/IEventDispatcher.php6
2 files changed, 6 insertions, 3 deletions
diff --git a/lib/public/AppFramework/Bootstrap/IRegistrationContext.php b/lib/public/AppFramework/Bootstrap/IRegistrationContext.php
index 002db267293..197275fb8e3 100644
--- a/lib/public/AppFramework/Bootstrap/IRegistrationContext.php
+++ b/lib/public/AppFramework/Bootstrap/IRegistrationContext.php
@@ -119,7 +119,8 @@ interface IRegistrationContext {
* @psalm-param string|class-string<T> $event preferably the fully-qualified class name of the Event sub class to listen for
* @param string $listener fully qualified class name (or ::class notation) of a \OCP\EventDispatcher\IEventListener that can be built by the DI container
* @psalm-param class-string<\OCP\EventDispatcher\IEventListener<T>> $listener fully qualified class name that can be built by the DI container
- * @param int $priority
+ * @param int $priority The higher this value, the earlier an event
+ * listener will be triggered in the chain (defaults to 0)
*
* @see IEventDispatcher::addServiceListener()
*
diff --git a/lib/public/EventDispatcher/IEventDispatcher.php b/lib/public/EventDispatcher/IEventDispatcher.php
index 6f3adf159c0..f38c0828bce 100644
--- a/lib/public/EventDispatcher/IEventDispatcher.php
+++ b/lib/public/EventDispatcher/IEventDispatcher.php
@@ -40,7 +40,8 @@ interface IEventDispatcher {
* @psalm-param string|class-string<T> $eventName preferably the fully-qualified class name of the Event sub class
* @param callable $listener the object that is invoked when a matching event is dispatched
* @psalm-param callable(T):void $listener
- * @param int $priority
+ * @param int $priority The higher this value, the earlier an event
+ * listener will be triggered in the chain (defaults to 0)
*
* @since 17.0.0
*/
@@ -63,7 +64,8 @@ interface IEventDispatcher {
* @psalm-param string|class-string<T> $eventName preferably the fully-qualified class name of the Event sub class to listen for
* @param string $className fully qualified class name (or ::class notation) of a \OCP\EventDispatcher\IEventListener that can be built by the DI container
* @psalm-param class-string<\OCP\EventDispatcher\IEventListener<T>> $className fully qualified class name that can be built by the DI container
- * @param int $priority
+ * @param int $priority The higher this value, the earlier an event
+ * listener will be triggered in the chain (defaults to 0)
*
* @since 17.0.0
*/