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