Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * This class introduces component to the system and provides all the | |
30 | * information about it. It needs to extend CRM_Core_Component_Info | |
31 | * abstract class. | |
32 | * | |
33 | * @package CRM | |
e7112fa7 | 34 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
35 | * $Id$ |
36 | * | |
37 | */ | |
38 | class CRM_Member_Info extends CRM_Core_Component_Info { | |
39 | ||
e7c15cb6 CW |
40 | /** |
41 | * @inheritDoc | |
42 | */ | |
6a488035 TO |
43 | protected $keyword = 'member'; |
44 | ||
bb3a214a | 45 | /** |
e7c15cb6 | 46 | * @inheritDoc |
bb3a214a EM |
47 | * Provides base information about the component. |
48 | * Needs to be implemented in component's information | |
49 | * class. | |
50 | * | |
a6c01b45 CW |
51 | * @return array |
52 | * collection of required component settings | |
bb3a214a EM |
53 | */ |
54 | /** | |
55 | * @return array | |
56 | */ | |
6a488035 TO |
57 | public function getInfo() { |
58 | return array( | |
59 | 'name' => 'CiviMember', | |
60 | 'translatedName' => ts('CiviMember'), | |
61 | 'title' => 'CiviCRM Membership Engine', | |
62 | 'search' => 1, | |
63 | 'showActivitiesInCore' => 1, | |
64 | ); | |
65 | } | |
66 | ||
67 | ||
bb3a214a | 68 | /** |
e7c15cb6 | 69 | * @inheritDoc |
bb3a214a EM |
70 | * Provides permissions that are used by component. |
71 | * Needs to be implemented in component's information | |
72 | * class. | |
73 | * | |
74 | * NOTE: if using conditionally permission return, | |
75 | * implementation of $getAllUnconditionally is required. | |
76 | * | |
77 | * @param bool $getAllUnconditionally | |
221b21b4 AH |
78 | * @param bool $descriptions |
79 | * Whether to return permission descriptions | |
bb3a214a | 80 | * |
72b3a70c CW |
81 | * @return array|null |
82 | * collection of permissions, null if none | |
bb3a214a | 83 | */ |
221b21b4 AH |
84 | public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) { |
85 | $permissions = array( | |
86 | 'access CiviMember' => array( | |
87 | ts('access CiviMember'), | |
88 | ts('View memberships'), | |
89 | ), | |
90 | 'edit memberships' => array( | |
91 | ts('edit memberships'), | |
92 | ts('Create and update memberships'), | |
93 | ), | |
94 | 'delete in CiviMember' => array( | |
95 | ts('delete in CiviMember'), | |
96 | ts('Delete memberships'), | |
97 | ), | |
6a488035 | 98 | ); |
221b21b4 AH |
99 | |
100 | if (!$descriptions) { | |
101 | foreach ($permissions as $name => $attr) { | |
102 | $permissions[$name] = array_shift($attr); | |
103 | } | |
104 | } | |
105 | ||
106 | return $permissions; | |
6a488035 TO |
107 | } |
108 | ||
bb3a214a | 109 | /** |
e7c15cb6 | 110 | * @inheritDoc |
bb3a214a EM |
111 | * Provides information about user dashboard element |
112 | * offered by this component. | |
113 | * | |
72b3a70c CW |
114 | * @return array|null |
115 | * collection of required dashboard settings, | |
bb3a214a | 116 | * null if no element offered |
bb3a214a EM |
117 | */ |
118 | /** | |
119 | * @return array|null | |
120 | */ | |
6a488035 | 121 | public function getUserDashboardElement() { |
b09fe5ed | 122 | return array( |
353ffa53 | 123 | 'name' => ts('Memberships'), |
6a488035 TO |
124 | 'title' => ts('Your Membership(s)'), |
125 | // this is CiviContribute specific permission, since | |
126 | // there is no permission that could be checked for | |
127 | // CiviMember | |
128 | 'perm' => array('make online contributions'), | |
129 | 'weight' => 30, | |
130 | ); | |
131 | } | |
132 | ||
bb3a214a | 133 | /** |
e7c15cb6 | 134 | * @inheritDoc |
bb3a214a EM |
135 | * Provides information about user dashboard element |
136 | * offered by this component. | |
137 | * | |
72b3a70c CW |
138 | * @return array|null |
139 | * collection of required dashboard settings, | |
bb3a214a | 140 | * null if no element offered |
bb3a214a EM |
141 | */ |
142 | /** | |
143 | * @return array|null | |
144 | */ | |
6a488035 | 145 | public function registerTab() { |
b09fe5ed | 146 | return array( |
353ffa53 | 147 | 'title' => ts('Memberships'), |
6a488035 TO |
148 | 'url' => 'membership', |
149 | 'weight' => 30, | |
150 | ); | |
151 | } | |
152 | ||
bb3a214a | 153 | /** |
e7c15cb6 | 154 | * @inheritDoc |
bb3a214a EM |
155 | * Provides information about advanced search pane |
156 | * offered by this component. | |
157 | * | |
72b3a70c CW |
158 | * @return array|null |
159 | * collection of required pane settings, | |
bb3a214a | 160 | * null if no element offered |
bb3a214a EM |
161 | */ |
162 | /** | |
163 | * @return array|null | |
164 | */ | |
6a488035 | 165 | public function registerAdvancedSearchPane() { |
b09fe5ed | 166 | return array( |
353ffa53 | 167 | 'title' => ts('Memberships'), |
6a488035 TO |
168 | 'weight' => 30, |
169 | ); | |
170 | } | |
171 | ||
bb3a214a | 172 | /** |
e7c15cb6 | 173 | * @inheritDoc |
bb3a214a EM |
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 | |
177 | * class. | |
178 | * | |
72b3a70c CW |
179 | * @return array|null |
180 | * collection of activity types | |
bb3a214a EM |
181 | */ |
182 | /** | |
183 | * @return array|null | |
184 | */ | |
6a488035 TO |
185 | public function getActivityTypes() { |
186 | return NULL; | |
187 | } | |
188 | ||
bb3a214a | 189 | /** |
fe482240 | 190 | * add shortcut to Create New. |
bb3a214a EM |
191 | * @param $shortCuts |
192 | * @param $newCredit | |
193 | */ | |
6a488035 TO |
194 | public function creatNewShortcut(&$shortCuts, $newCredit) { |
195 | if (CRM_Core_Permission::check('access CiviMember') && | |
196 | CRM_Core_Permission::check('edit memberships') | |
197 | ) { | |
6b5ca1ea | 198 | $shortCut[] = array( |
199 | 'path' => 'civicrm/member/add', | |
200 | 'query' => "reset=1&action=add&context=standalone", | |
201 | 'ref' => 'new-membership', | |
202 | 'title' => ts('Membership'), | |
203 | ); | |
6a488035 TO |
204 | if ($newCredit) { |
205 | $title = ts('Membership') . '<br /> (' . ts('credit card') . ')'; | |
6b5ca1ea | 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', | |
210 | 'title' => $title, | |
211 | ); | |
6a488035 | 212 | } |
6b5ca1ea | 213 | $shortCuts = array_merge($shortCuts, $shortCut); |
6a488035 TO |
214 | } |
215 | } | |
96025800 | 216 | |
6a488035 | 217 | } |