CRM/Contribute/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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_Contribute_Info extends CRM_Core_Component_Info {
  39
  40
  41   // docs inherited from interface
  42   protected $keyword = 'contribute';
  43
  44   // docs inherited from interface
  45   public function getInfo() {
  46     return array(
  47       'name' => 'CiviContribute',
  48       'translatedName' => ts('CiviContribute'),
  49       'title' => ts('CiviCRM Contribution Engine'),
  50       'search' => 1,
  51       'showActivitiesInCore' => 1,
  52     );
  53   }
  54
  55   // docs inherited from interface
  56   public function getPermissions($getAllUnconditionally = FALSE) {
  57     return array(
  58       'access CiviContribute',
  59       'edit contributions',
  60       'make online contributions',
  61       'delete in CiviContribute',
  62     );
  63   }
  64
  65   public function getAnonymousPermissionWarnings() {
  66     return array(
  67       'access CiviContribute',
  68     );
  69   }
  70
  71   // docs inherited from interface
  72   public function getUserDashboardElement() {
  73     return array('name' => ts('Contributions'),
  74       'title' => ts('Your Contribution(s)'),
  75       'perm' => array('make online contributions'),
  76       'weight' => 10,
  77     );
  78   }
  79
  80   // docs inherited from interface
  81   public function registerTab() {
  82     return array('title' => ts('Contributions'),
  83       'url' => 'contribution',
  84       'weight' => 20,
  85     );
  86   }
  87
  88   // docs inherited from interface
  89   public function registerAdvancedSearchPane() {
  90     return array(
  91       'title' => ts('Contributions'),
  92       'weight' => 20,
  93     );
  94   }
  95
  96   // docs inherited from interface
  97   public function getActivityTypes() {
  98     return NULL;
  99   }
 100
 101   // add shortcut to Create New
 102   public function creatNewShortcut(&$shortCuts, $newCredit) {
 103     if (CRM_Core_Permission::check('access CiviContribute') &&
 104       CRM_Core_Permission::check('edit contributions')
 105     ) {
 106       $shortCut[] = array(
 107         'path' => 'civicrm/contribute/add',
 108         'query' => "reset=1&action=add&context=standalone",
 109         'ref' => 'new-contribution',
 110         'title' => ts('Contribution'),
 111       );
 112       if ($newCredit) {
 113         $title = ts('Contribution') . '<br />&nbsp;&nbsp;(' . ts('credit card') . ')';
 114         $shortCut[0]['shortCuts'][] = array(
 115           'path' => 'civicrm/contribute/add',
 116           'query' => "reset=1&action=add&context=standalone&mode=live",
 117           'ref' => 'new-contribution-cc',
 118           'title' => $title,
 119         );
 120       }
 121       $shortCuts = array_merge($shortCuts, $shortCut);
 122     }
 123   }
 124 }
 125