3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
36 class CRM_Contribute_Info
extends CRM_Core_Component_Info
{
42 protected $keyword = 'contribute';
46 * Provides base information about the component.
47 * Needs to be implemented in component's information
51 * collection of required component settings
56 public function getInfo() {
58 'name' => 'CiviContribute',
59 'translatedName' => ts('CiviContribute'),
60 'title' => ts('CiviCRM Contribution Engine'),
62 'showActivitiesInCore' => 1,
68 * Provides permissions that are used by component.
69 * Needs to be implemented in component's information
72 * NOTE: if using conditionally permission return,
73 * implementation of $getAllUnconditionally is required.
75 * @param bool $getAllUnconditionally
76 * @param bool $descriptions
77 * Whether to return permission descriptions
80 * collection of permissions, null if none
83 * @param bool $getAllUnconditionally
87 public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
89 'access CiviContribute' => array(
90 ts('access CiviContribute'),
91 ts('Record backend contributions (with edit contributions) and view all contributions (for visible contacts)'),
93 'edit contributions' => array(
94 ts('edit contributions'),
95 ts('Record and update contributions'),
97 'make online contributions' => array(
98 ts('make online contributions'),
100 'delete in CiviContribute' => array(
101 ts('delete in CiviContribute'),
102 ts('Delete contributions'),
106 if (!$descriptions) {
107 foreach ($permissions as $name => $attr) {
108 $permissions[$name] = array_shift($attr);
116 * Provides permissions that are unwise for Anonymous Roles to have.
119 * list of permissions
120 * @see CRM_Component_Info::getPermissions
125 public function getAnonymousPermissionWarnings() {
127 'access CiviContribute',
133 * Provides information about user dashboard element
134 * offered by this component.
137 * collection of required dashboard settings,
138 * null if no element offered
143 public function getUserDashboardElement() {
145 'name' => ts('Contributions'),
146 'title' => ts('Your Contribution(s)'),
147 'perm' => array('make online contributions'),
154 * Provides information about user dashboard element
155 * offered by this component.
158 * collection of required dashboard settings,
159 * null if no element offered
164 public function registerTab() {
166 'title' => ts('Contributions'),
167 'url' => 'contribution',
174 * Provides information about advanced search pane
175 * offered by this component.
178 * collection of required pane settings,
179 * null if no element offered
184 public function registerAdvancedSearchPane() {
186 'title' => ts('Contributions'),
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
199 * collection of activity types
204 public function getActivityTypes() {
209 * add shortcut to Create New.
213 public function creatNewShortcut(&$shortCuts, $newCredit) {
214 if (CRM_Core_Permission
::check('access CiviContribute') &&
215 CRM_Core_Permission
::check('edit contributions')
218 'path' => 'civicrm/contribute/add',
219 'query' => "reset=1&action=add&context=standalone",
220 'ref' => 'new-contribution',
221 'title' => ts('Contribution'),
224 $title = ts('Contribution') . '<br /> (' . 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',
232 $shortCuts = array_merge($shortCuts, $shortCut);