Merge pull request #17484 from civicrm/5.26

[civicrm-core.git] / Civi / Token / Event / TokenRegisterEvent.php

diff --git a/Civi/Token/Event/TokenRegisterEvent.php b/Civi/Token/Event/TokenRegisterEvent.php
index ff9122543c430d10e93b2247cfcd0b742e4f32cc..730ddb616c87c662f83d0be2d0b10eb15ec18264 100644 (file)
--- a/Civi/Token/Event/TokenRegisterEvent.php
+++ b/Civi/Token/Event/TokenRegisterEvent.php
@@ -8,7 +8,7 @@ namespace Civi\Token\Event;
  * The TokenRegisterEvent is fired when constructing a list of available
  * tokens. Listeners may register by specifying the entity/field/label for the token.
  *
- * @code
+ * ```
  * $ev->entity('profile')
  *    ->register('viewUrl', ts('Default Profile URL (View Mode)')
  *    ->register('editUrl', ts('Default Profile URL (Edit Mode)');
@@ -17,7 +17,9 @@ namespace Civi\Token\Event;
  *   'field' => 'viewUrl',
  *   'label' => ts('Default Profile URL (View Mode)'),
  * ));
- * @endcode
+ * ```
+ *
+ * Event name: 'civi.token.list'
  */
 class TokenRegisterEvent extends TokenEvent {
 
@@ -57,10 +59,10 @@ class TokenRegisterEvent extends TokenEvent {
       $params = $paramsOrField;
     }
     else {
-      $params = array(
+      $params = [
         'field' => $paramsOrField,
         'label' => $label,
-      );
+      ];
     }
     $params = array_merge($this->defaults, $params);
     $this->tokenProcessor->addToken($params);