CRM/Pledge/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_Pledge_Info extends CRM_Core_Component_Info {
  39
  40   // docs inherited from interface
  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   // docs inherited from interface
  63   /**
  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    *
  73    * @return array|null collection of permissions, null if none
  74    */
  75   /**
  76    * @param bool $getAllUnconditionally
  77    *
  78    * @return array|null
  79    */
  80   public function getPermissions($getAllUnconditionally = FALSE) {
  81     return array(
  82       'access CiviPledge',
  83       'edit pledges',
  84       'delete in CiviPledge',
  85     );
  86   }
  87
  88   // docs inherited from interface
  89   /**
  90    * Provides information about user dashboard element
  91    * offered by this component.
  92    *
  93    * @return array|null collection of required dashboard settings,
  94    *                    null if no element offered
  95    */
  96   /**
  97    * @return array|null
  98    */
  99   public function getUserDashboardElement() {
 100     return array(
 101     'name' => ts('Pledges'),
 102       'title' => ts('Your Pledge(s)'),
 103       // we need to check this permission since you can click on contribution page link for making payment
 104       'perm' => array('make online contributions'),
 105       'weight' => 15,
 106     );
 107   }
 108
 109   // docs inherited from interface
 110   /**
 111    * Provides information about user dashboard element
 112    * offered by this component.
 113    *
 114    * @return array|null collection of required dashboard settings,
 115    *                    null if no element offered
 116    */
 117   /**
 118    * @return array|null
 119    */
 120   public function registerTab() {
 121     return array(
 122     'title' => ts('Pledges'),
 123       'url' => 'pledge',
 124       'weight' => 25,
 125     );
 126   }
 127
 128   // docs inherited from interface
 129   /**
 130    * Provides information about advanced search pane
 131    * offered by this component.
 132    *
 133    * @return array|null collection of required pane settings,
 134    *                    null if no element offered
 135    */
 136   /**
 137    * @return array|null
 138    */
 139   public function registerAdvancedSearchPane() {
 140     return array(
 141     'title' => ts('Pledges'),
 142       'weight' => 25,
 143     );
 144   }
 145
 146   // docs inherited from interface
 147   /**
 148    * Provides potential activity types that this
 149    * component might want to register in activity history.
 150    * Needs to be implemented in component's information
 151    * class.
 152    *
 153    * @return array|null collection of activity types
 154    */
 155   /**
 156    * @return array|null
 157    */
 158   public function getActivityTypes() {
 159     return NULL;
 160   }
 161
 162   // add shortcut to Create New
 163   /**
 164    * @param $shortCuts
 165    */
 166   public function creatNewShortcut(&$shortCuts) {
 167     if (CRM_Core_Permission::check('access CiviPledge') &&
 168       CRM_Core_Permission::check('edit pledges')
 169     ) {
 170       $shortCuts = array_merge($shortCuts, array(
 171         array(
 172       'path' => 'civicrm/pledge/add',
 173             'query' => 'reset=1&action=add&context=standalone',
 174             'ref' => 'new-pledge',
 175             'title' => ts('Pledge'),
 176           )));
 177     }
 178   }
 179 }