| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.7 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 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-2015 |
| 35 | */ |
| 36 | class CRM_Campaign_Info extends CRM_Core_Component_Info { |
| 37 | |
| 38 | /** |
| 39 | * @inheritDoc |
| 40 | */ |
| 41 | protected $keyword = 'campaign'; |
| 42 | |
| 43 | /** |
| 44 | * @inheritDoc |
| 45 | * @return array |
| 46 | */ |
| 47 | public function getInfo() { |
| 48 | return array( |
| 49 | 'name' => 'CiviCampaign', |
| 50 | 'translatedName' => ts('CiviCampaign'), |
| 51 | 'title' => 'CiviCRM Campaign Engine', |
| 52 | 'search' => 1, |
| 53 | 'showActivitiesInCore' => 1, |
| 54 | ); |
| 55 | } |
| 56 | |
| 57 | |
| 58 | /** |
| 59 | * @inheritDoc |
| 60 | * @param bool $getAllUnconditionally |
| 61 | * @param bool $descriptions |
| 62 | * Whether to return permission descriptions |
| 63 | * |
| 64 | * @return array |
| 65 | */ |
| 66 | public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) { |
| 67 | $permissions = array( |
| 68 | 'administer CiviCampaign' => array( |
| 69 | ts('administer CiviCampaign'), |
| 70 | ts('Create new campaign, survey and petition types and their status'), |
| 71 | ), |
| 72 | 'manage campaign' => array( |
| 73 | ts('manage campaign'), |
| 74 | ts('Create new campaigns, surveys and petitions, reserve respondents'), |
| 75 | ), |
| 76 | 'reserve campaign contacts' => array( |
| 77 | ts('reserve campaign contacts'), |
| 78 | ts('Reserve campaign contacts for surveys and petitions'), |
| 79 | ), |
| 80 | 'release campaign contacts' => array( |
| 81 | ts('release campaign contacts'), |
| 82 | ts('Release reserved campaign contacts for surveys and petitions'), |
| 83 | ), |
| 84 | 'interview campaign contacts' => array( |
| 85 | ts('interview campaign contacts'), |
| 86 | ts('Record survey and petition responses from their reserved contacts'), |
| 87 | ), |
| 88 | 'gotv campaign contacts' => array( |
| 89 | ts('GOTV campaign contacts'), |
| 90 | ts('Record that contacts voted'), |
| 91 | ), |
| 92 | 'sign CiviCRM Petition' => array( |
| 93 | ts('sign CiviCRM Petition'), |
| 94 | ), |
| 95 | ); |
| 96 | |
| 97 | if (!$descriptions) { |
| 98 | foreach ($permissions as $name => $attr) { |
| 99 | $permissions[$name] = array_shift($attr); |
| 100 | } |
| 101 | } |
| 102 | |
| 103 | return $permissions; |
| 104 | } |
| 105 | |
| 106 | |
| 107 | /** |
| 108 | * @inheritDoc |
| 109 | * @return null |
| 110 | */ |
| 111 | public function getUserDashboardElement() { |
| 112 | // no dashboard element for this component |
| 113 | return NULL; |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * @return null |
| 118 | */ |
| 119 | public function getUserDashboardObject() { |
| 120 | // no dashboard element for this component |
| 121 | return NULL; |
| 122 | } |
| 123 | |
| 124 | /** |
| 125 | * @inheritDoc |
| 126 | * @return null |
| 127 | */ |
| 128 | public function registerTab() { |
| 129 | // this component doesn't use contact record tabs |
| 130 | return NULL; |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * @inheritDoc |
| 135 | * @return null |
| 136 | */ |
| 137 | public function registerAdvancedSearchPane() { |
| 138 | // this component doesn't use advanced search |
| 139 | return NULL; |
| 140 | } |
| 141 | |
| 142 | /** |
| 143 | * @inheritDoc |
| 144 | */ |
| 145 | public function getActivityTypes() { |
| 146 | return NULL; |
| 147 | } |
| 148 | |
| 149 | /** |
| 150 | * add shortcut to Create New. |
| 151 | * @param $shortCuts |
| 152 | */ |
| 153 | public function creatNewShortcut(&$shortCuts) { |
| 154 | if (CRM_Core_Permission::check('manage campaign') || |
| 155 | CRM_Core_Permission::check('administer CiviCampaign') |
| 156 | ) { |
| 157 | $shortCuts = array_merge($shortCuts, array( |
| 158 | array( |
| 159 | 'path' => 'civicrm/campaign/add', |
| 160 | 'query' => "reset=1&action=add", |
| 161 | 'ref' => 'new-campaign', |
| 162 | 'title' => ts('Campaign'), |
| 163 | ), |
| 164 | array( |
| 165 | 'path' => 'civicrm/survey/add', |
| 166 | 'query' => "reset=1&action=add", |
| 167 | 'ref' => 'new-survey', |
| 168 | 'title' => ts('Survey'), |
| 169 | ), |
| 170 | )); |
| 171 | } |
| 172 | } |
| 173 | |
| 174 | } |