CRM/Pledge/Info.php

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