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_Contribute_Info
extends CRM_Core_Component_Info
{
41 // docs inherited from interface
42 protected $keyword = 'contribute';
44 // docs inherited from interface
46 * Provides base information about the component.
47 * Needs to be implemented in component's information
50 * @return array collection of required component settings
57 public function getInfo() {
59 'name' => 'CiviContribute',
60 'translatedName' => ts('CiviContribute'),
61 'title' => ts('CiviCRM Contribution Engine'),
63 'showActivitiesInCore' => 1,
67 // docs inherited from interface
69 * Provides permissions that are used by component.
70 * Needs to be implemented in component's information
73 * NOTE: if using conditionally permission return,
74 * implementation of $getAllUnconditionally is required.
76 * @param bool $getAllUnconditionally
78 * @return array|null collection of permissions, null if none
82 * @param bool $getAllUnconditionally
86 public function getPermissions($getAllUnconditionally = FALSE) {
88 'access CiviContribute',
90 'make online contributions',
91 'delete in CiviContribute',
96 * Provides permissions that are unwise for Anonymous Roles to have
98 * @return array list of permissions
99 * @see CRM_Component_Info::getPermissions
104 public function getAnonymousPermissionWarnings() {
106 'access CiviContribute',
110 // docs inherited from interface
112 * Provides information about user dashboard element
113 * offered by this component.
115 * @return array|null collection of required dashboard settings,
116 * null if no element offered
123 public function getUserDashboardElement() {
124 return array('name' => ts('Contributions'),
125 'title' => ts('Your Contribution(s)'),
126 'perm' => array('make online contributions'),
131 // docs inherited from interface
133 * Provides information about user dashboard element
134 * offered by this component.
136 * @return array|null collection of required dashboard settings,
137 * null if no element offered
144 public function registerTab() {
145 return array('title' => ts('Contributions'),
146 'url' => 'contribution',
151 // docs inherited from interface
153 * Provides information about advanced search pane
154 * offered by this component.
156 * @return array|null collection of required pane settings,
157 * null if no element offered
164 public function registerAdvancedSearchPane() {
166 'title' => ts('Contributions'),
171 // docs inherited from interface
173 * Provides potential activity types that this
174 * component might want to register in activity history.
175 * Needs to be implemented in component's information
178 * @return array|null collection of activity types
185 public function getActivityTypes() {
189 // add shortcut to Create New
194 public function creatNewShortcut(&$shortCuts, $newCredit) {
195 if (CRM_Core_Permission
::check('access CiviContribute') &&
196 CRM_Core_Permission
::check('edit contributions')
199 'path' => 'civicrm/contribute/add',
200 'query' => "reset=1&action=add&context=standalone",
201 'ref' => 'new-contribution',
202 'title' => ts('Contribution'),
205 $title = ts('Contribution') . '<br /> (' . ts('credit card') . ')';
206 $shortCut[0]['shortCuts'][] = array(
207 'path' => 'civicrm/contribute/add',
208 'query' => "reset=1&action=add&context=standalone&mode=live",
209 'ref' => 'new-contribution-cc',
213 $shortCuts = array_merge($shortCuts, $shortCut);