CRM/Campaign/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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   // docs inherited from interface
  41   protected $keyword = 'campaign';
  42
  43   // docs inherited from interface
  44   public function getInfo() {
  45     return array(
  46       'name' => 'CiviCampaign',
  47       'translatedName' => ts('CiviCampaign'),
  48       'title' => 'CiviCRM Campaign Engine',
  49       'search' => 1,
  50       'showActivitiesInCore' => 1,
  51     );
  52   }
  53
  54
  55   // docs inherited from interface
  56   public function getPermissions($getAllUnconditionally = FALSE) {
  57     return array(
  58       'administer CiviCampaign',
  59       'manage campaign',
  60       'reserve campaign contacts',
  61       'release campaign contacts',
  62       'interview campaign contacts',
  63       'gotv campaign contacts',
  64       'sign CiviCRM Petition',
  65     );
  66   }
  67
  68
  69   // docs inherited from interface
  70   public function getUserDashboardElement() {
  71     // no dashboard element for this component
  72     return NULL;
  73   }
  74
  75   public function getUserDashboardObject() {
  76     // no dashboard element for this component
  77     return NULL;
  78   }
  79
  80   // docs inherited from interface
  81   public function registerTab() {
  82     // this component doesn't use contact record tabs
  83     return NULL;
  84   }
  85
  86   // docs inherited from interface
  87   public function registerAdvancedSearchPane() {
  88     // this component doesn't use advanced search
  89     return NULL;
  90   }
  91
  92   // docs inherited from interface
  93   public function getActivityTypes() {
  94     return NULL;
  95   }
  96
  97   // add shortcut to Create New
  98   public function creatNewShortcut(&$shortCuts) {
  99     if (CRM_Core_Permission::check('manage campaign') ||
 100       CRM_Core_Permission::check('administer CiviCampaign')
 101     ) {
 102       $shortCuts = array_merge($shortCuts, array(
 103         array('path' => 'civicrm/campaign/add',
 104             'query' => "reset=1&action=add",
 105             'ref' => 'new-campaign',
 106             'title' => ts('Campaign'),
 107           ),
 108           array(
 109             'path' => 'civicrm/survey/add',
 110             'query' => "reset=1&action=add",
 111             'ref' => 'new-survey',
 112             'title' => ts('Survey'),
 113           ),
 114         ));
 115     }
 116   }
 117 }
 118