Merge pull request #16429 from ixiam/dev/core#1113

[civicrm-core.git] / Civi / API / Event / AuthorizeEvent.php

diff --git a/Civi/API/Event/AuthorizeEvent.php b/Civi/API/Event/AuthorizeEvent.php
index 82c63438247f6901459d31eae8e35ab852c78b4b..9d146a9b40f6824976ff62101ba3b02d02c9f526 100644 (file)
--- a/Civi/API/Event/AuthorizeEvent.php
+++ b/Civi/API/Event/AuthorizeEvent.php
@@ -14,6 +14,12 @@ namespace Civi\API\Event;
 /**
  * Class AuthorizeEvent
  * @package Civi\API\Event
+ *
+ * Determine whether the API request is allowed for the current user.
+ * For successful execution, at least one listener must invoke
+ * $event->authorize().
+ *
+ * Event name: 'civi.api.authorize'
  */
 class AuthorizeEvent extends Event {
   /**