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
38 class CRM_Member_Info
extends CRM_Core_Component_Info
{
43 protected $keyword = 'member';
47 * Provides base information about the component.
48 * Needs to be implemented in component's information
52 * collection of required component settings
57 public function getInfo() {
59 'name' => 'CiviMember',
60 'translatedName' => ts('CiviMember'),
61 'title' => ts('CiviCRM Membership Engine'),
63 '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
84 public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
86 'access CiviMember' => array(
87 ts('access CiviMember'),
88 ts('View memberships'),
90 'edit memberships' => array(
91 ts('edit memberships'),
92 ts('Create and update memberships'),
94 'delete in CiviMember' => array(
95 ts('delete in CiviMember'),
96 ts('Delete memberships'),
100 if (!$descriptions) {
101 foreach ($permissions as $name => $attr) {
102 $permissions[$name] = array_shift($attr);
111 * Provides information about user dashboard element
112 * offered by this component.
115 * collection of required dashboard settings,
116 * null if no element offered
121 public function getUserDashboardElement() {
123 'name' => ts('Memberships'),
124 'title' => ts('Your Membership(s)'),
125 // this is CiviContribute specific permission, since
126 // there is no permission that could be checked for
128 'perm' => array('make online contributions'),
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 registerTab() {
147 'title' => ts('Memberships'),
148 'url' => 'membership',
155 * Provides information about advanced search pane
156 * offered by this component.
159 * collection of required pane settings,
160 * null if no element offered
165 public function registerAdvancedSearchPane() {
167 'title' => ts('Memberships'),
174 * Provides potential activity types that this
175 * component might want to register in activity history.
176 * Needs to be implemented in component's information
180 * collection of activity types
185 public function getActivityTypes() {
190 * add shortcut to Create New.
194 public function creatNewShortcut(&$shortCuts, $newCredit) {
195 if (CRM_Core_Permission
::check('access CiviMember') &&
196 CRM_Core_Permission
::check('edit memberships')
199 'path' => 'civicrm/member/add',
200 'query' => "reset=1&action=add&context=standalone",
201 'ref' => 'new-membership',
202 'title' => ts('Membership'),
205 $title = ts('Membership') . '<br /> (' . ts('credit card') . ')';
206 $shortCut[0]['shortCuts'][] = array(
207 'path' => 'civicrm/member/add',
208 'query' => "reset=1&action=add&context=standalone&mode=live",
209 'ref' => 'new-membership-cc',
213 $shortCuts = array_merge($shortCuts, $shortCut);