3 +--------------------------------------------------------------------+
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_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
82 public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
84 'access CiviContribute' => array(
85 ts('access CiviContribute'),
86 ts('Record backend contributions (with edit contributions) and view all contributions (for visible contacts)'),
88 'edit contributions' => array(
89 ts('edit contributions'),
90 ts('Record and update contributions'),
92 'make online contributions' => array(
93 ts('make online contributions'),
95 'delete in CiviContribute' => array(
96 ts('delete in CiviContribute'),
97 ts('Delete contributions'),
101 if (!$descriptions) {
102 foreach ($permissions as $name => $attr) {
103 $permissions[$name] = array_shift($attr);
111 * Provides permissions that are unwise for Anonymous Roles to have.
114 * list of permissions
115 * @see CRM_Component_Info::getPermissions
120 public function getAnonymousPermissionWarnings() {
122 'access CiviContribute',
128 * Provides information about user dashboard element
129 * offered by this component.
132 * collection of required dashboard settings,
133 * null if no element offered
138 public function getUserDashboardElement() {
140 'name' => ts('Contributions'),
141 'title' => ts('Your Contribution(s)'),
142 'perm' => array('make online contributions'),
149 * Provides information about user dashboard element
150 * offered by this component.
153 * collection of required dashboard settings,
154 * null if no element offered
159 public function registerTab() {
161 'title' => ts('Contributions'),
162 'url' => 'contribution',
171 public function getIcon() {
172 return 'crm-i fa-credit-card';
177 * Provides information about advanced search pane
178 * offered by this component.
181 * collection of required pane settings,
182 * null if no element offered
187 public function registerAdvancedSearchPane() {
189 'title' => ts('Contributions'),
196 * Provides potential activity types that this
197 * component might want to register in activity history.
198 * Needs to be implemented in component's information
202 * collection of activity types
207 public function getActivityTypes() {
212 * add shortcut to Create New.
216 public function creatNewShortcut(&$shortCuts, $newCredit) {
217 if (CRM_Core_Permission
::check('access CiviContribute') &&
218 CRM_Core_Permission
::check('edit contributions')
221 'path' => 'civicrm/contribute/add',
222 'query' => "reset=1&action=add&context=standalone",
223 'ref' => 'new-contribution',
224 'title' => ts('Contribution'),
227 $title = ts('Contribution') . '<br /> (' . ts('credit card') . ')';
228 $shortCut[0]['shortCuts'][] = array(
229 'path' => 'civicrm/contribute/add',
230 'query' => "reset=1&action=add&context=standalone&mode=live",
231 'ref' => 'new-contribution-cc',
235 $shortCuts = array_merge($shortCuts, $shortCut);