3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
36 class CRM_Pledge_Info
extends CRM_Core_Component_Info
{
41 protected $keyword = 'pledge';
44 * Provides base information about the component.
45 * Needs to be implemented in component's information
49 * 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,
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
72 * @param bool $descriptions
73 * Whether to return permission descriptions
76 * collection of permissions, null if none
78 public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
80 'access CiviPledge' => array(
81 ts('access CiviPledge'),
84 'edit pledges' => array(
86 ts('Create and update pledges'),
88 'delete in CiviPledge' => array(
89 ts('delete in CiviPledge'),
95 foreach ($permissions as $name => $attr) {
96 $permissions[$name] = array_shift($attr);
105 * Provides information about user dashboard element
106 * offered by this component.
109 * collection of required dashboard settings,
110 * null if no element offered
112 public function getUserDashboardElement() {
114 'name' => ts('Pledges'),
115 'title' => ts('Your Pledge(s)'),
116 // we need to check this permission since you can click on contribution page link for making payment
117 'perm' => array('make online contributions'),
124 * Provides information about user dashboard element
125 * offered by this component.
128 * collection of required dashboard settings,
129 * null if no element offered
131 public function registerTab() {
133 'title' => ts('Pledges'),
141 * Provides information about advanced search pane
142 * offered by this component.
145 * collection of required pane settings,
146 * null if no element offered
148 public function registerAdvancedSearchPane() {
150 'title' => ts('Pledges'),
157 * Provides potential activity types that this
158 * component might want to register in activity history.
159 * Needs to be implemented in component's information
163 * collection of activity types
165 public function getActivityTypes() {
170 * add shortcut to Create New.
173 public function creatNewShortcut(&$shortCuts) {
174 if (CRM_Core_Permission
::check('access CiviPledge') &&
175 CRM_Core_Permission
::check('edit pledges')
177 $shortCuts = array_merge($shortCuts, array(
179 'path' => 'civicrm/pledge/add',
180 'query' => 'reset=1&action=add&context=standalone',
181 'ref' => 'new-pledge',
182 'title' => ts('Pledge'),