CRM/Contribute/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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_Contribute_Info extends CRM_Core_Component_Info {
  39
  40
  41   /**
  42    * @inheritDoc
  43    */
  44   protected $keyword = 'contribute';
  45
  46   /**
  47    * @inheritDoc
  48    * Provides base information about the component.
  49    * Needs to be implemented in component's information
  50    * class.
  51    *
  52    * @return array
  53    *   collection of required component settings
  54    */
  55   /**
  56    * @return array
  57    */
  58   public function getInfo() {
  59     return array(
  60       'name' => 'CiviContribute',
  61       'translatedName' => ts('CiviContribute'),
  62       'title' => ts('CiviCRM Contribution Engine'),
  63       'search' => 1,
  64       'showActivitiesInCore' => 1,
  65     );
  66   }
  67
  68   /**
  69    * @inheritDoc
  70    * Provides permissions that are used by component.
  71    * Needs to be implemented in component's information
  72    * class.
  73    *
  74    * NOTE: if using conditionally permission return,
  75    * implementation of $getAllUnconditionally is required.
  76    *
  77    * @param bool $getAllUnconditionally
  78    * @param bool $descriptions
  79    *   Whether to return permission descriptions
  80    *
  81    * @return array|null
  82    *   collection of permissions, null if none
  83    */
  84   /**
  85    * @param bool $getAllUnconditionally
  86    *
  87    * @return array|null
  88    */
  89   public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
  90     $permissions = array(
  91       'access CiviContribute' => array(
  92         ts('access CiviContribute'),
  93         ts('Record backend contributions (with edit contributions) and view all contributions (for visible contacts)'),
  94       ),
  95       'edit contributions' => array(
  96         ts('edit contributions'),
  97         ts('Record and update contributions'),
  98       ),
  99       'make online contributions' => array(
 100         ts('make online contributions'),
 101       ),
 102       'delete in CiviContribute' => array(
 103         ts('delete in CiviContribute'),
 104         ts('Delete contributions'),
 105       ),
 106     );
 107
 108     if (!$descriptions) {
 109       foreach ($permissions as $name => $attr) {
 110         $permissions[$name] = array_shift($attr);
 111       }
 112     }
 113
 114     return $permissions;
 115   }
 116
 117   /**
 118    * Provides permissions that are unwise for Anonymous Roles to have.
 119    *
 120    * @return array
 121    *   list of permissions
 122    * @see CRM_Component_Info::getPermissions
 123    */
 124   /**
 125    * @return array
 126    */
 127   public function getAnonymousPermissionWarnings() {
 128     return array(
 129       'access CiviContribute',
 130     );
 131   }
 132
 133   /**
 134    * @inheritDoc
 135    * Provides information about user dashboard element
 136    * offered by this component.
 137    *
 138    * @return array|null
 139    *   collection of required dashboard settings,
 140    *                    null if no element offered
 141    */
 142   /**
 143    * @return array|null
 144    */
 145   public function getUserDashboardElement() {
 146     return array(
 147       'name' => ts('Contributions'),
 148       'title' => ts('Your Contribution(s)'),
 149       'perm' => array('make online contributions'),
 150       'weight' => 10,
 151     );
 152   }
 153
 154   /**
 155    * @inheritDoc
 156    * Provides information about user dashboard element
 157    * offered by this component.
 158    *
 159    * @return array|null
 160    *   collection of required dashboard settings,
 161    *                    null if no element offered
 162    */
 163   /**
 164    * @return array|null
 165    */
 166   public function registerTab() {
 167     return array(
 168       'title' => ts('Contributions'),
 169       'url' => 'contribution',
 170       'weight' => 20,
 171     );
 172   }
 173
 174   /**
 175    * @inheritDoc
 176    * Provides information about advanced search pane
 177    * offered by this component.
 178    *
 179    * @return array|null
 180    *   collection of required pane settings,
 181    *                    null if no element offered
 182    */
 183   /**
 184    * @return array|null
 185    */
 186   public function registerAdvancedSearchPane() {
 187     return array(
 188       'title' => ts('Contributions'),
 189       'weight' => 20,
 190     );
 191   }
 192
 193   /**
 194    * @inheritDoc
 195    * Provides potential activity types that this
 196    * component might want to register in activity history.
 197    * Needs to be implemented in component's information
 198    * class.
 199    *
 200    * @return array|null
 201    *   collection of activity types
 202    */
 203   /**
 204    * @return array|null
 205    */
 206   public function getActivityTypes() {
 207     return NULL;
 208   }
 209
 210   /**
 211    * add shortcut to Create New.
 212    * @param $shortCuts
 213    * @param $newCredit
 214    */
 215   public function creatNewShortcut(&$shortCuts, $newCredit) {
 216     if (CRM_Core_Permission::check('access CiviContribute') &&
 217       CRM_Core_Permission::check('edit contributions')
 218     ) {
 219       $shortCut[] = array(
 220         'path' => 'civicrm/contribute/add',
 221         'query' => "reset=1&action=add&context=standalone",
 222         'ref' => 'new-contribution',
 223         'title' => ts('Contribution'),
 224       );
 225       if ($newCredit) {
 226         $title = ts('Contribution') . '<br />&nbsp;&nbsp;(' . ts('credit card') . ')';
 227         $shortCut[0]['shortCuts'][] = array(
 228           'path' => 'civicrm/contribute/add',
 229           'query' => "reset=1&action=add&context=standalone&mode=live",
 230           'ref' => 'new-contribution-cc',
 231           'title' => $title,
 232         );
 233       }
 234       $shortCuts = array_merge($shortCuts, $shortCut);
 235     }
 236   }
 237
 238 }