CRM/Pledge/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_Pledge_Info extends CRM_Core_Component_Info {
  39
  40   // docs inherited from interface
  41   protected $keyword = 'pledge';
  42
  43   // docs inherited from interface
  44   public function getInfo() {
  45     return array(
  46       'name' => 'CiviPledge',
  47       'translatedName' => ts('CiviPledge'),
  48       'title' => ts('CiviCRM Pledge Engine'),
  49       'search' => 1,
  50       'showActivitiesInCore' => 1,
  51     );
  52   }
  53
  54
  55   // docs inherited from interface
  56   public function getPermissions($getAllUnconditionally = FALSE) {
  57     return array(
  58       'access CiviPledge',
  59       'edit pledges',
  60       'delete in CiviPledge',
  61     );
  62   }
  63
  64   // docs inherited from interface
  65   public function getUserDashboardElement() {
  66     return array('name' => ts('Pledges'),
  67       'title' => ts('Your Pledge(s)'),
  68       // we need to check this permission since you can click on contribution page link for making payment
  69       'perm' => array('make online contributions'),
  70       'weight' => 15,
  71     );
  72   }
  73
  74   // docs inherited from interface
  75   public function registerTab() {
  76     return array('title' => ts('Pledges'),
  77       'url' => 'pledge',
  78       'weight' => 25,
  79     );
  80   }
  81
  82   // docs inherited from interface
  83   public function registerAdvancedSearchPane() {
  84     return array('title' => ts('Pledges'),
  85       'weight' => 25,
  86     );
  87   }
  88
  89   // docs inherited from interface
  90   public function getActivityTypes() {
  91     return NULL;
  92   }
  93
  94   // add shortcut to Create New
  95   public function creatNewShortcut(&$shortCuts) {
  96     if (CRM_Core_Permission::check('access CiviPledge') &&
  97       CRM_Core_Permission::check('edit pledges')
  98     ) {
  99       $shortCuts = array_merge($shortCuts, array(
 100         array('path' => 'civicrm/pledge/add',
 101             'query' => 'reset=1&action=add&context=standalone',
 102             'ref' => 'new-pledge',
 103             'title' => ts('Pledge'),
 104           )));
 105     }
 106   }
 107 }
 108