3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This class introduces component to the system and provides all the
30 * information about it. It needs to extend CRM_Core_Component_Info
34 * @copyright CiviCRM LLC (c) 2004-2014
38 class CRM_Pledge_Info
extends CRM_Core_Component_Info
{
40 // docs inherited from interface
41 protected $keyword = 'pledge';
44 * Provides base information about the component.
45 * Needs to be implemented in component's information
48 * @return array collection of required component settings
51 public function getInfo() {
53 'name' => 'CiviPledge',
54 'translatedName' => ts('CiviPledge'),
55 'title' => ts('CiviCRM Pledge Engine'),
57 'showActivitiesInCore' => 1,
62 // docs inherited from interface
64 * Provides permissions that are used by component.
65 * Needs to be implemented in component's information
68 * NOTE: if using conditionally permission return,
69 * implementation of $getAllUnconditionally is required.
71 * @param bool $getAllUnconditionally
73 * @return array|null collection of permissions, null if none
77 * @param bool $getAllUnconditionally
81 public function getPermissions($getAllUnconditionally = FALSE) {
85 'delete in CiviPledge',
89 // docs inherited from interface
91 * Provides information about user dashboard element
92 * offered by this component.
94 * @return array|null collection of required dashboard settings,
95 * null if no element offered
102 public function getUserDashboardElement() {
103 return array('name' => ts('Pledges'),
104 'title' => ts('Your Pledge(s)'),
105 // we need to check this permission since you can click on contribution page link for making payment
106 'perm' => array('make online contributions'),
111 // docs inherited from interface
113 * Provides information about user dashboard element
114 * offered by this component.
116 * @return array|null collection of required dashboard settings,
117 * null if no element offered
124 public function registerTab() {
125 return array('title' => ts('Pledges'),
131 // docs inherited from interface
133 * Provides information about advanced search pane
134 * offered by this component.
136 * @return array|null collection of required pane settings,
137 * null if no element offered
144 public function registerAdvancedSearchPane() {
145 return array('title' => ts('Pledges'),
150 // docs inherited from interface
152 * Provides potential activity types that this
153 * component might want to register in activity history.
154 * Needs to be implemented in component's information
157 * @return array|null collection of activity types
164 public function getActivityTypes() {
168 // add shortcut to Create New
172 public function creatNewShortcut(&$shortCuts) {
173 if (CRM_Core_Permission
::check('access CiviPledge') &&
174 CRM_Core_Permission
::check('edit pledges')
176 $shortCuts = array_merge($shortCuts, array(
177 array('path' => 'civicrm/pledge/add',
178 'query' => 'reset=1&action=add&context=standalone',
179 'ref' => 'new-pledge',
180 'title' => ts('Pledge'),