dev/core#389 [preliminary cleanup] Standardise metadat for custom field use
[civicrm-core.git] / CRM / Event / Info.php
index afd957c157f1c33a2198f9debfc0944b8350dd6d..8e3e5338cafaa36a66cf0dc4db9a2d90a813596f 100644 (file)
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 5                                                  |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2018                                |
+ | Copyright CiviCRM LLC (c) 2004-2019                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  * abstract class.
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2018
+ * @copyright CiviCRM LLC (c) 2004-2019
  * $Id$
  *
  */
 class CRM_Event_Info extends CRM_Core_Component_Info {
 
   /**
+   * @var string
    * @inheritDoc
    */
   protected $keyword = 'event';
@@ -47,13 +48,13 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
    * @return array
    */
   public function getInfo() {
-    return array(
+    return [
       'name' => 'CiviEvent',
       'translatedName' => ts('CiviEvent'),
       'title' => ts('CiviCRM Event Engine'),
       'search' => 1,
       'showActivitiesInCore' => 1,
-    );
+    ];
   }
 
   /**
@@ -65,39 +66,39 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
    * @return array
    */
   public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
-    $permissions = array(
-      'access CiviEvent' => array(
+    $permissions = [
+      'access CiviEvent' => [
         ts('access CiviEvent'),
         ts('Create events, view all events, and view participant records (for visible contacts)'),
-      ),
-      'edit event participants' => array(
+      ],
+      'edit event participants' => [
         ts('edit event participants'),
         ts('Record and update backend event registrations'),
-      ),
-      'edit all events' => array(
+      ],
+      'edit all events' => [
         ts('edit all events'),
         ts('Edit events even without specific ACL granted'),
-      ),
-      'register for events' => array(
+      ],
+      'register for events' => [
         ts('register for events'),
         ts('Register for events online'),
-      ),
-      'view event info' => array(
+      ],
+      'view event info' => [
         ts('view event info'),
         ts('View online event information pages'),
-      ),
-      'view event participants' => array(
+      ],
+      'view event participants' => [
         ts('view event participants'),
-      ),
-      'delete in CiviEvent' => array(
+      ],
+      'delete in CiviEvent' => [
         ts('delete in CiviEvent'),
         ts('Delete participants and events that you can edit'),
-      ),
-      'manage event profiles' => array(
+      ],
+      'manage event profiles' => [
         ts('manage event profiles'),
         ts('Allow users to create, edit and copy event-related profile forms used for online event registration.'),
-      ),
-    );
+      ],
+    ];
 
     if (!$descriptions) {
       foreach ($permissions as $name => $attr) {
@@ -112,9 +113,9 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
    * @return array
    */
   public function getAnonymousPermissionWarnings() {
-    return array(
+    return [
       'access CiviEvent',
-    );
+    ];
   }
 
   /**
@@ -122,12 +123,12 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
    * @return array
    */
   public function getUserDashboardElement() {
-    return array(
+    return [
       'name' => ts('Events'),
       'title' => ts('Your Event(s)'),
-      'perm' => array('register for events'),
+      'perm' => ['register for events'],
       'weight' => 20,
-    );
+    ];
   }
 
   /**
@@ -135,12 +136,20 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
    * @return array
    */
   public function registerTab() {
-    return array(
+    return [
       'title' => ts('Events'),
       'id' => 'participant',
       'url' => 'participant',
       'weight' => 40,
-    );
+    ];
+  }
+
+  /**
+   * @inheritDoc
+   * @return string
+   */
+  public function getIcon() {
+    return 'crm-i fa-calendar';
   }
 
   /**
@@ -148,10 +157,10 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
    * @return array
    */
   public function registerAdvancedSearchPane() {
-    return array(
+    return [
       'title' => ts('Events'),
       'weight' => 40,
-    );
+    ];
   }
 
   /**
@@ -159,11 +168,11 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
    * @return array
    */
   public function getActivityTypes() {
-    $types = array();
-    $types['Event'] = array(
+    $types = [];
+    $types['Event'] = [
       'title' => ts('Event'),
       'callback' => 'CRM_Event_Page_EventInfo::run()',
-    );
+    ];
     return $types;
   }
 
@@ -176,20 +185,20 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
     if (CRM_Core_Permission::check('access CiviEvent') &&
       CRM_Core_Permission::check('edit event participants')
     ) {
-      $shortCut[] = array(
+      $shortCut[] = [
         'path' => 'civicrm/participant/add',
         'query' => "reset=1&action=add&context=standalone",
         'ref' => 'new-participant',
         'title' => ts('Event Registration'),
-      );
+      ];
       if ($newCredit) {
         $title = ts('Event Registration') . '<br />&nbsp;&nbsp;(' . ts('credit card') . ')';
-        $shortCut[0]['shortCuts'][] = array(
+        $shortCut[0]['shortCuts'][] = [
           'path' => 'civicrm/participant/add',
           'query' => "reset=1&action=add&context=standalone&mode=live",
           'ref' => 'new-participant-cc',
           'title' => $title,
-        );
+        ];
       }
       $shortCuts = array_merge($shortCuts, $shortCut);
     }