CRM/Campaign/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_Campaign_Info extends CRM_Core_Component_Info {
  39
  40   /**
  41    * @inheritDoc
  42    */
  43   protected $keyword = 'campaign';
  44
  45   /**
  46    * @inheritDoc
  47    * @return array
  48    */
  49   public function getInfo() {
  50     return array(
  51       'name' => 'CiviCampaign',
  52       'translatedName' => ts('CiviCampaign'),
  53       'title' => 'CiviCRM Campaign Engine',
  54       'search' => 1,
  55       'showActivitiesInCore' => 1,
  56     );
  57   }
  58
  59
  60   /**
  61    * @inheritDoc
  62    * @param bool $getAllUnconditionally
  63    *
  64    * @return array
  65    */
  66   public function getPermissions($getAllUnconditionally = FALSE) {
  67     return array(
  68       'administer CiviCampaign',
  69       'manage campaign',
  70       'reserve campaign contacts',
  71       'release campaign contacts',
  72       'interview campaign contacts',
  73       'gotv campaign contacts',
  74       'sign CiviCRM Petition',
  75     );
  76   }
  77
  78
  79   /**
  80    * @inheritDoc
  81    * @return null
  82    */
  83   public function getUserDashboardElement() {
  84     // no dashboard element for this component
  85     return NULL;
  86   }
  87
  88   /**
  89    * @return null
  90    */
  91   public function getUserDashboardObject() {
  92     // no dashboard element for this component
  93     return NULL;
  94   }
  95
  96   /**
  97    * @inheritDoc
  98    * @return null
  99    */
 100   public function registerTab() {
 101     // this component doesn't use contact record tabs
 102     return NULL;
 103   }
 104
 105   /**
 106    * @inheritDoc
 107    * @return null
 108    */
 109   public function registerAdvancedSearchPane() {
 110     // this component doesn't use advanced search
 111     return NULL;
 112   }
 113
 114   /**
 115    * @inheritDoc
 116    */
 117   public function getActivityTypes() {
 118     return NULL;
 119   }
 120
 121   /**
 122    * add shortcut to Create New.
 123    * @param $shortCuts
 124    */
 125   public function creatNewShortcut(&$shortCuts) {
 126     if (CRM_Core_Permission::check('manage campaign') ||
 127       CRM_Core_Permission::check('administer CiviCampaign')
 128     ) {
 129       $shortCuts = array_merge($shortCuts, array(
 130         array(
 131           'path' => 'civicrm/campaign/add',
 132           'query' => "reset=1&action=add",
 133           'ref' => 'new-campaign',
 134           'title' => ts('Campaign'),
 135         ),
 136         array(
 137           'path' => 'civicrm/survey/add',
 138           'query' => "reset=1&action=add",
 139           'ref' => 'new-survey',
 140           'title' => ts('Survey'),
 141         ),
 142       ));
 143     }
 144   }
 145
 146 }