3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
38 class CRM_Contribute_Info
extends CRM_Core_Component_Info
{
44 protected $keyword = 'contribute';
48 * Provides base information about the component.
49 * Needs to be implemented in component's information
53 * collection of required component settings
58 public function getInfo() {
60 'name' => 'CiviContribute',
61 'translatedName' => ts('CiviContribute'),
62 'title' => ts('CiviCRM Contribution Engine'),
64 'showActivitiesInCore' => 1,
70 * Provides permissions that are used by component.
71 * Needs to be implemented in component's information
74 * NOTE: if using conditionally permission return,
75 * implementation of $getAllUnconditionally is required.
77 * @param bool $getAllUnconditionally
78 * @param bool $descriptions
79 * Whether to return permission descriptions
82 * collection of permissions, null if none
85 * @param bool $getAllUnconditionally
89 public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
91 'access CiviContribute' => array(
92 ts('access CiviContribute'),
93 ts('Record backend contributions (with edit contributions) and view all contributions (for visible contacts)'),
95 'edit contributions' => array(
96 ts('edit contributions'),
97 ts('Record and update contributions'),
99 'make online contributions' => array(
100 ts('make online contributions'),
102 'delete in CiviContribute' => array(
103 ts('delete in CiviContribute'),
104 ts('Delete contributions'),
108 if (!$descriptions) {
109 foreach ($permissions as $name => $attr) {
110 $permissions[$name] = array_shift($attr);
118 * Provides permissions that are unwise for Anonymous Roles to have.
121 * list of permissions
122 * @see CRM_Component_Info::getPermissions
127 public function getAnonymousPermissionWarnings() {
129 'access CiviContribute',
135 * Provides information about user dashboard element
136 * offered by this component.
139 * collection of required dashboard settings,
140 * null if no element offered
145 public function getUserDashboardElement() {
147 'name' => ts('Contributions'),
148 'title' => ts('Your Contribution(s)'),
149 'perm' => array('make online contributions'),
156 * Provides information about user dashboard element
157 * offered by this component.
160 * collection of required dashboard settings,
161 * null if no element offered
166 public function registerTab() {
168 'title' => ts('Contributions'),
169 'url' => 'contribution',
176 * Provides information about advanced search pane
177 * offered by this component.
180 * collection of required pane settings,
181 * null if no element offered
186 public function registerAdvancedSearchPane() {
188 'title' => ts('Contributions'),
195 * Provides potential activity types that this
196 * component might want to register in activity history.
197 * Needs to be implemented in component's information
201 * collection of activity types
206 public function getActivityTypes() {
211 * add shortcut to Create New.
215 public function creatNewShortcut(&$shortCuts, $newCredit) {
216 if (CRM_Core_Permission
::check('access CiviContribute') &&
217 CRM_Core_Permission
::check('edit contributions')
220 'path' => 'civicrm/contribute/add',
221 'query' => "reset=1&action=add&context=standalone",
222 'ref' => 'new-contribution',
223 'title' => ts('Contribution'),
226 $title = ts('Contribution') . '<br /> (' . ts('credit card') . ')';
227 $shortCut[0]['shortCuts'][] = array(
228 'path' => 'civicrm/contribute/add',
229 'query' => "reset=1&action=add&context=standalone&mode=live",
230 'ref' => 'new-contribution-cc',
234 $shortCuts = array_merge($shortCuts, $shortCut);