CRM/Pledge/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  35  */
  36 class CRM_Pledge_Info extends CRM_Core_Component_Info {
  37
  38   /**
  39    * @inheritDoc
  40    */
  41   protected $keyword = 'pledge';
  42
  43   /**
  44    * Provides base information about the component.
  45    * Needs to be implemented in component's information
  46    * class.
  47    *
  48    * @return array
  49    *   collection of required component settings
  50    */
  51   public function getInfo() {
  52     return array(
  53       'name' => 'CiviPledge',
  54       'translatedName' => ts('CiviPledge'),
  55       'title' => ts('CiviCRM Pledge Engine'),
  56       'search' => 1,
  57       'showActivitiesInCore' => 1,
  58     );
  59   }
  60
  61
  62   /**
  63    * @inheritDoc
  64    * Provides permissions that are used by component.
  65    * Needs to be implemented in component's information
  66    * class.
  67    *
  68    * NOTE: if using conditionally permission return,
  69    * implementation of $getAllUnconditionally is required.
  70    *
  71    * @param bool $getAllUnconditionally
  72    * @param bool $descriptions
  73    *   Whether to return permission descriptions
  74    *
  75    * @return array|null
  76    *   collection of permissions, null if none
  77    */
  78   public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
  79     $permissions = array(
  80       'access CiviPledge' => array(
  81         ts('access CiviPledge'),
  82         ts('View pledges'),
  83       ),
  84       'edit pledges' => array(
  85         ts('edit pledges'),
  86         ts('Create and update pledges'),
  87       ),
  88       'delete in CiviPledge' => array(
  89         ts('delete in CiviPledge'),
  90         ts('Delete pledges'),
  91       ),
  92     );
  93
  94     if (!$descriptions) {
  95       foreach ($permissions as $name => $attr) {
  96         $permissions[$name] = array_shift($attr);
  97       }
  98     }
  99
 100     return $permissions;
 101   }
 102
 103   /**
 104    * @inheritDoc
 105    * Provides information about user dashboard element
 106    * offered by this component.
 107    *
 108    * @return array|null
 109    *   collection of required dashboard settings,
 110    *                    null if no element offered
 111    */
 112   public function getUserDashboardElement() {
 113     return array(
 114       'name' => ts('Pledges'),
 115       'title' => ts('Your Pledge(s)'),
 116       // we need to check this permission since you can click on contribution page link for making payment
 117       'perm' => array('make online contributions'),
 118       'weight' => 15,
 119     );
 120   }
 121
 122   /**
 123    * @inheritDoc
 124    * Provides information about user dashboard element
 125    * offered by this component.
 126    *
 127    * @return array|null
 128    *   collection of required dashboard settings,
 129    *                    null if no element offered
 130    */
 131   public function registerTab() {
 132     return array(
 133       'title' => ts('Pledges'),
 134       'url' => 'pledge',
 135       'weight' => 25,
 136     );
 137   }
 138
 139   /**
 140    * @inheritDoc
 141    * Provides information about advanced search pane
 142    * offered by this component.
 143    *
 144    * @return array|null
 145    *   collection of required pane settings,
 146    *                    null if no element offered
 147    */
 148   public function registerAdvancedSearchPane() {
 149     return array(
 150       'title' => ts('Pledges'),
 151       'weight' => 25,
 152     );
 153   }
 154
 155   /**
 156    * @inheritDoc
 157    * Provides potential activity types that this
 158    * component might want to register in activity history.
 159    * Needs to be implemented in component's information
 160    * class.
 161    *
 162    * @return array|null
 163    *   collection of activity types
 164    */
 165   public function getActivityTypes() {
 166     return NULL;
 167   }
 168
 169   /**
 170    * add shortcut to Create New.
 171    * @param $shortCuts
 172    */
 173   public function creatNewShortcut(&$shortCuts) {
 174     if (CRM_Core_Permission::check('access CiviPledge') &&
 175       CRM_Core_Permission::check('edit pledges')
 176     ) {
 177       $shortCuts = array_merge($shortCuts, array(
 178         array(
 179           'path' => 'civicrm/pledge/add',
 180           'query' => 'reset=1&action=add&context=standalone',
 181           'ref' => 'new-pledge',
 182           'title' => ts('Pledge'),
 183         ),
 184       ));
 185     }
 186   }
 187
 188 }