CRM/Event/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This class introduces component to the system and provides all the
  30  * information about it. It needs to extend CRM_Core_Component_Info
  31  * abstract class.
  32  *
  33  * @package CRM
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * $Id$
  36  *
  37  */
  38 class CRM_Event_Info extends CRM_Core_Component_Info {
  39
  40   /**
  41    * @inheritDoc
  42    */
  43   protected $keyword = 'event';
  44
  45   /**
  46    * @inheritDoc
  47    * @return array
  48    */
  49   public function getInfo() {
  50     return array(
  51       'name' => 'CiviEvent',
  52       'translatedName' => ts('CiviEvent'),
  53       'title' => ts('CiviCRM Event Engine'),
  54       'search' => 1,
  55       'showActivitiesInCore' => 1,
  56     );
  57   }
  58
  59   /**
  60    * @inheritDoc
  61    * @param bool $getAllUnconditionally
  62    *
  63    * @return array
  64    */
  65   public function getPermissions($getAllUnconditionally = FALSE) {
  66     return array(
  67       'access CiviEvent',
  68       'edit event participants',
  69       'edit all events',
  70       'register for events',
  71       'view event info',
  72       'view event participants',
  73       'delete in CiviEvent',
  74     );
  75   }
  76
  77   /**
  78    * @return array
  79    */
  80   public function getAnonymousPermissionWarnings() {
  81     return array(
  82       'access CiviEvent',
  83     );
  84   }
  85
  86   /**
  87    * @inheritDoc
  88    * @return array
  89    */
  90   public function getUserDashboardElement() {
  91     return array(
  92       'name' => ts('Events'),
  93       'title' => ts('Your Event(s)'),
  94       'perm' => array('register for events'),
  95       'weight' => 20,
  96     );
  97   }
  98
  99   /**
 100    * @inheritDoc
 101    * @return array
 102    */
 103   public function registerTab() {
 104     return array(
 105       'title' => ts('Events'),
 106       'id' => 'participant',
 107       'url' => 'participant',
 108       'weight' => 40,
 109     );
 110   }
 111
 112   /**
 113    * @inheritDoc
 114    * @return array
 115    */
 116   public function registerAdvancedSearchPane() {
 117     return array(
 118       'title' => ts('Events'),
 119       'weight' => 40,
 120     );
 121   }
 122
 123   /**
 124    * @inheritDoc
 125    * @return array
 126    */
 127   public function getActivityTypes() {
 128     $types = array();
 129     $types['Event'] = array(
 130       'title' => ts('Event'),
 131       'callback' => 'CRM_Event_Page_EventInfo::run()',
 132     );
 133     return $types;
 134   }
 135
 136   /**
 137    * add shortcut to Create New.
 138    * @param $shortCuts
 139    * @param $newCredit
 140    */
 141   public function creatNewShortcut(&$shortCuts, $newCredit) {
 142     if (CRM_Core_Permission::check('access CiviEvent') &&
 143       CRM_Core_Permission::check('edit event participants')
 144     ) {
 145       $shortCut[] = array(
 146         'path' => 'civicrm/participant/add',
 147         'query' => "reset=1&action=add&context=standalone",
 148         'ref' => 'new-participant',
 149         'title' => ts('Event Registration'),
 150       );
 151       if ($newCredit) {
 152         $title = ts('Event Registration') . '<br />&nbsp;&nbsp;(' . ts('credit card') . ')';
 153         $shortCut[0]['shortCuts'][] = array(
 154           'path' => 'civicrm/participant/add',
 155           'query' => "reset=1&action=add&context=standalone&mode=live",
 156           'ref' => 'new-participant-cc',
 157           'title' => $title,
 158         );
 159       }
 160       $shortCuts = array_merge($shortCuts, $shortCut);
 161     }
 162   }
 163
 164 }