Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Create a page for displaying UF Groups. | |
38 | * | |
39 | * Heart of this class is the run method which checks | |
40 | * for action type and then displays the appropriate | |
41 | * page. | |
42 | * | |
43 | */ | |
44 | class CRM_UF_Page_Group extends CRM_Core_Page { | |
45 | ||
46 | /** | |
47 | * The action links that we need to display for the browse screen | |
48 | * | |
49 | * @var array | |
50 | */ | |
51 | private static $_actionLinks = NULL; | |
52 | ||
53 | /** | |
54 | * Get the action links for this page. | |
55 | * | |
56 | * @param | |
57 | * | |
58 | * @return array $_actionLinks | |
59 | * | |
60 | */ | |
00be9182 | 61 | public function &actionLinks() { |
6a488035 TO |
62 | // check if variable _actionsLinks is populated |
63 | if (!self::$_actionLinks) { | |
64 | // helper variable for nicer formatting | |
65 | $copyExtra = ts('Are you sure you want to make a copy of this Profile?'); | |
66 | self::$_actionLinks = array( | |
67 | CRM_Core_Action::BROWSE => array( | |
68 | 'name' => ts('Fields'), | |
69 | 'url' => 'civicrm/admin/uf/group/field', | |
70 | 'qs' => 'reset=1&action=browse&gid=%%id%%', | |
71 | 'title' => ts('View and Edit Fields'), | |
72 | ), | |
73 | CRM_Core_Action::UPDATE => array( | |
74 | 'name' => ts('Settings'), | |
75 | 'url' => 'civicrm/admin/uf/group/update', | |
76 | 'qs' => 'action=update&id=%%id%%&context=group', | |
77 | 'title' => ts('Edit CiviCRM Profile Group'), | |
78 | ), | |
79 | CRM_Core_Action::PREVIEW => array( | |
80 | 'name' => ts('Preview'), | |
81 | 'url' => 'civicrm/admin/uf/group', | |
82 | 'qs' => 'action=preview&id=%%id%%&field=0&context=group', | |
83 | 'title' => ts('Edit CiviCRM Profile Group'), | |
84 | ), | |
85 | CRM_Core_Action::ADD => array( | |
86 | 'name' => ts('Use Profile-Create Mode'), | |
87 | 'url' => 'civicrm/profile/create', | |
88 | 'qs' => 'gid=%%id%%&reset=1', | |
89 | 'title' => ts('Use Profile-Create Mode'), | |
3507f83e | 90 | 'fe' => true, |
6a488035 | 91 | ), |
9865c956 DG |
92 | CRM_Core_Action::BASIC => array( |
93 | 'name' => ts('Use Profile-Listings Mode'), | |
94 | 'url' => 'civicrm/profile', | |
95 | 'qs' => 'gid=%%id%%&reset=1', | |
96 | 'title' => ts('Use Profile-Listings Mode'), | |
97 | 'fe' => true, | |
98 | ), | |
6a488035 TO |
99 | CRM_Core_Action::DISABLE => array( |
100 | 'name' => ts('Disable'), | |
4d17a233 | 101 | 'ref' => 'crm-enable-disable', |
6a488035 TO |
102 | 'title' => ts('Disable CiviCRM Profile Group'), |
103 | ), | |
104 | CRM_Core_Action::ENABLE => array( | |
105 | 'name' => ts('Enable'), | |
4d17a233 | 106 | 'ref' => 'crm-enable-disable', |
6a488035 TO |
107 | 'title' => ts('Enable CiviCRM Profile Group'), |
108 | ), | |
109 | CRM_Core_Action::DELETE => array( | |
110 | 'name' => ts('Delete'), | |
111 | 'url' => 'civicrm/admin/uf/group', | |
112 | 'qs' => 'action=delete&id=%%id%%', | |
113 | 'title' => ts('Delete CiviCRM Profile Group'), | |
114 | ), | |
115 | CRM_Core_Action::PROFILE => array( | |
116 | 'name' => ts('HTML Form Snippet'), | |
117 | 'url' => 'civicrm/admin/uf/group', | |
118 | 'qs' => 'action=profile&gid=%%id%%', | |
119 | 'title' => ts('HTML Form Snippet for this Profile'), | |
120 | ), | |
121 | CRM_Core_Action::COPY => array( | |
122 | 'name' => ts('Copy Profile'), | |
123 | 'url' => 'civicrm/admin/uf/group', | |
124 | 'qs' => 'action=copy&gid=%%id%%', | |
125 | 'title' => ts('Make a Copy of CiviCRM Profile Group'), | |
126 | 'extra' => 'onclick = "return confirm(\'' . $copyExtra . '\');"', | |
127 | ), | |
128 | ); | |
129 | } | |
130 | return self::$_actionLinks; | |
131 | } | |
132 | ||
133 | /** | |
134 | * Run the page. | |
135 | * | |
136 | * This method is called after the page is created. It checks for the | |
137 | * type of action and executes that action. | |
138 | * Finally it calls the parent's run method. | |
139 | * | |
140 | * @param | |
141 | * | |
142 | * @return void | |
6a488035 | 143 | */ |
00be9182 | 144 | public function run() { |
6a488035 TO |
145 | // get the requested action |
146 | $action = CRM_Utils_Request::retrieve('action', 'String', | |
147 | $this, FALSE, | |
148 | // default to 'browse' | |
149 | 'browse' | |
150 | ); | |
151 | ||
152 | // assign vars to templates | |
153 | $this->assign('action', $action); | |
154 | $id = CRM_Utils_Request::retrieve('id', 'Positive', | |
155 | $this, FALSE, 0 | |
156 | ); | |
157 | ||
158 | //set the context and then start w/ action. | |
159 | $this->setContext($id, $action); | |
160 | ||
161 | // what action to take ? | |
162 | if ($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD | CRM_Core_Action::DELETE | CRM_Core_Action::DISABLE)) { | |
163 | $this->edit($id, $action); | |
164 | } | |
165 | else { | |
166 | // if action is enable or disable do the needful. | |
167 | if ($action & CRM_Core_Action::ENABLE) { | |
168 | CRM_Core_BAO_UFGroup::setIsActive($id, 1); | |
169 | ||
170 | // update cms integration with registration / my account | |
171 | CRM_Utils_System::updateCategories(); | |
172 | } | |
173 | elseif ($action & CRM_Core_Action::PROFILE) { | |
174 | $this->profile(); | |
175 | CRM_Utils_System::setTitle(ts('%1 - HTML Form Snippet', array(1 => $this->_title))); | |
176 | } | |
177 | elseif ($action & CRM_Core_Action::PREVIEW) { | |
178 | $this->preview($id, $action); | |
179 | } | |
180 | elseif ($action & CRM_Core_Action::COPY) { | |
181 | $this->copy(); | |
182 | } | |
183 | // finally browse the uf groups | |
184 | $this->browse(); | |
185 | } | |
186 | // parent run | |
187 | return parent::run(); | |
188 | } | |
189 | ||
190 | /** | |
191 | * This function is to make a copy of a profile, including | |
192 | * all the fields in the profile | |
193 | * | |
194 | * @return void | |
6a488035 | 195 | */ |
00be9182 | 196 | public function copy() { |
6a488035 TO |
197 | $gid = CRM_Utils_Request::retrieve('gid', 'Positive', |
198 | $this, TRUE, 0, 'GET' | |
199 | ); | |
200 | ||
201 | CRM_Core_BAO_UFGroup::copy($gid); | |
202 | CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/uf/group', 'reset=1')); | |
203 | } | |
204 | ||
205 | /** | |
206 | * This function is for profile mode (standalone html form ) for uf group | |
207 | * | |
208 | * @return void | |
6a488035 | 209 | */ |
00be9182 | 210 | public function profile() { |
6a488035 TO |
211 | $config = CRM_Core_Config::singleton(); |
212 | ||
213 | // reassign resource base to be the full url, CRM-4660 | |
214 | $config->resourceBase = $config->userFrameworkResourceURL; | |
215 | $config->useFrameworkRelativeBase = $config->userFrameworkBaseURL; | |
216 | ||
217 | $gid = CRM_Utils_Request::retrieve('gid', 'Positive', | |
218 | $this, FALSE, 0, 'GET' | |
219 | ); | |
220 | $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Edit', ts('Create'), CRM_Core_Action::ADD, | |
221 | FALSE, FALSE, TRUE | |
222 | ); | |
223 | $controller->reset(); | |
224 | $controller->process(); | |
225 | $controller->set('gid', $gid); | |
226 | $controller->setEmbedded(TRUE); | |
227 | $controller->run(); | |
228 | $template = CRM_Core_Smarty::singleton(); | |
229 | $template->assign('gid', $gid); | |
230 | $template->assign('tplFile', 'CRM/Profile/Form/Edit.tpl'); | |
880e33cd | 231 | $profile = trim($template->fetch('CRM/Form/default.tpl')); |
6a488035 TO |
232 | |
233 | // not sure how to circumvent our own navigation system to generate the right form url | |
234 | $urlReplaceWith = 'civicrm/profile/create&gid=' . $gid . '&reset=1'; | |
235 | if ($config->userSystem->is_drupal && $config->cleanURL) { | |
236 | $urlReplaceWith = 'civicrm/profile/create?gid=' . $gid . '&reset=1'; | |
237 | } | |
238 | $profile = str_replace('civicrm/admin/uf/group', $urlReplaceWith, $profile); | |
239 | ||
8c63e816 CW |
240 | // FIXME: (CRM-3587) hack to make standalone profile work |
241 | // in wordpress and joomla without administrator login | |
6a488035 TO |
242 | if ($config->userFramework == 'Joomla') { |
243 | $profile = str_replace('/administrator/', '/index.php', $profile); | |
244 | } | |
013e44b2 CW |
245 | elseif ($config->userFramework == 'WordPress') { |
246 | $profile = str_replace('/wp-admin/admin.php', '/index.php', $profile); | |
6a488035 TO |
247 | } |
248 | ||
880e33cd CW |
249 | // add header files |
250 | CRM_Core_Resources::singleton()->addCoreResources('html-header'); | |
251 | $profile = CRM_Core_Region::instance('html-header')->render('', FALSE) . $profile; | |
6a488035 | 252 | |
6a488035 TO |
253 | $this->assign('profile', htmlentities($profile, ENT_NOQUOTES, 'UTF-8')); |
254 | //get the title of uf group | |
255 | if ($gid) { | |
256 | $title = CRM_Core_BAO_UFGroup::getTitle($gid); | |
257 | $this->_title = $title; | |
258 | } | |
259 | else { | |
260 | $title = 'Profile Form'; | |
261 | } | |
262 | ||
263 | $this->assign('title', $title); | |
264 | $this->assign('action', CRM_Core_Action::PROFILE); | |
265 | $this->assign('isForm', 0); | |
266 | } | |
267 | ||
268 | /** | |
100fef9d | 269 | * Edit uf group |
6a488035 | 270 | * |
5ce1712d TO |
271 | * @param int $id |
272 | * Uf group id. | |
273 | * @param string $action | |
274 | * The action to be invoked. | |
6a488035 TO |
275 | * |
276 | * @return void | |
6a488035 | 277 | */ |
00be9182 | 278 | public function edit($id, $action) { |
6a488035 TO |
279 | // create a simple controller for editing uf data |
280 | $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Group', ts('CiviCRM Profile Group'), $action); | |
281 | $this->setContext($id, $action); | |
282 | $controller->set('id', $id); | |
283 | $controller->setEmbedded(TRUE); | |
284 | $controller->process(); | |
285 | $controller->run(); | |
286 | } | |
287 | ||
288 | /** | |
289 | * Browse all uf data groups. | |
290 | * | |
291 | * @param | |
292 | * | |
293 | * @return void | |
6a488035 TO |
294 | * @static |
295 | */ | |
00be9182 | 296 | public function browse($action = NULL) { |
6a488035 TO |
297 | $ufGroup = array(); |
298 | $allUFGroups = array(); | |
299 | $allUFGroups = CRM_Core_BAO_UFGroup::getModuleUFGroup(); | |
300 | if (empty($allUFGroups)) { | |
301 | return; | |
302 | } | |
303 | ||
ff4f7744 | 304 | $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id'); |
6a488035 TO |
305 | CRM_Utils_Hook::aclGroup(CRM_Core_Permission::ADMIN, NULL, 'civicrm_uf_group', $ufGroups, $allUFGroups); |
306 | ||
307 | foreach ($allUFGroups as $id => $value) { | |
308 | $ufGroup[$id] = array(); | |
309 | $ufGroup[$id]['id'] = $id; | |
310 | $ufGroup[$id]['title'] = $value['title']; | |
bcbde5ca AW |
311 | $ufGroup[$id]['created_id'] = $value['created_id']; |
312 | $ufGroup[$id]['created_by'] = CRM_Contact_BAO_Contact::displayName($value['created_id']); | |
313 | $ufGroup[$id]['description'] = $value['description']; | |
6a488035 TO |
314 | $ufGroup[$id]['is_active'] = $value['is_active']; |
315 | $ufGroup[$id]['group_type'] = $value['group_type']; | |
316 | $ufGroup[$id]['is_reserved'] = $value['is_reserved']; | |
317 | ||
318 | // form all action links | |
319 | $action = array_sum(array_keys($this->actionLinks())); | |
320 | ||
321 | // update enable/disable links depending on uf_group properties. | |
322 | if ($value['is_active']) { | |
323 | $action -= CRM_Core_Action::ENABLE; | |
324 | } | |
325 | else { | |
326 | $action -= CRM_Core_Action::DISABLE; | |
327 | } | |
328 | ||
329 | // drop certain actions if the profile is reserved | |
330 | if ($value['is_reserved']) { | |
331 | $action -= CRM_Core_Action::UPDATE; | |
332 | $action -= CRM_Core_Action::DISABLE; | |
333 | $action -= CRM_Core_Action::DELETE; | |
334 | } | |
335 | ||
336 | $groupTypes = self::extractGroupTypes($value['group_type']); | |
1cb28d5d | 337 | $groupComponents = array('Contribution', 'Membership', 'Activity', 'Participant', 'Case'); |
6a488035 TO |
338 | |
339 | // drop Create, Edit and View mode links if profile group_type is Contribution, Membership, Activities or Participant | |
340 | $componentFound = array_intersect($groupComponents, array_keys($groupTypes)); | |
341 | if (!empty($componentFound)) { | |
342 | $action -= CRM_Core_Action::ADD; | |
343 | } | |
344 | ||
345 | $groupTypesString = ''; | |
346 | if (!empty($groupTypes)) { | |
347 | $groupTypesStrings = array(); | |
348 | foreach ($groupTypes as $groupType => $typeValues) { | |
349 | if (is_array($typeValues)) { | |
350 | if ($groupType == 'Participant') { | |
351 | foreach ($typeValues as $subType => $subTypeValues) { | |
352 | $groupTypesStrings[] = $subType . '::' . implode(': ', $subTypeValues); | |
353 | } | |
354 | } | |
355 | else { | |
356 | $groupTypesStrings[] = $groupType . '::' . implode(': ', current($typeValues)); | |
357 | } | |
358 | } | |
359 | else { | |
360 | $groupTypesStrings[] = $groupType; | |
361 | } | |
362 | } | |
363 | $groupTypesString = implode(', ', $groupTypesStrings); | |
364 | } | |
365 | $ufGroup[$id]['group_type'] = $groupTypesString; | |
366 | ||
367 | $ufGroup[$id]['action'] = CRM_Core_Action::formLink(self::actionLinks(), $action, | |
87dab4a4 AH |
368 | array('id' => $id), |
369 | ts('more'), | |
370 | FALSE, | |
371 | 'ufGroup.row.actions', | |
372 | 'UFGroup', | |
373 | $id | |
6a488035 TO |
374 | ); |
375 | //get the "Used For" from uf_join | |
376 | $ufGroup[$id]['module'] = implode(', ', CRM_Core_BAO_UFGroup::getUFJoinRecord($id, TRUE)); | |
377 | } | |
378 | ||
379 | $this->assign('rows', $ufGroup); | |
380 | } | |
381 | ||
382 | /** | |
100fef9d | 383 | * This function is for preview mode for ufoup |
6a488035 | 384 | * |
5ce1712d TO |
385 | * @param int $id |
386 | * Uf group id. | |
6a488035 | 387 | * |
77b97be7 EM |
388 | * @param $action |
389 | * | |
6a488035 | 390 | * @return void |
6a488035 | 391 | */ |
00be9182 | 392 | public function preview($id, $action) { |
6a488035 TO |
393 | $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Preview', ts('CiviCRM Profile Group Preview'), NULL); |
394 | $controller->set('id', $id); | |
395 | $controller->setEmbedded(TRUE); | |
396 | $controller->process(); | |
397 | $controller->run(); | |
398 | } | |
399 | ||
624e56fa | 400 | /** |
100fef9d | 401 | * @param int $id |
624e56fa EM |
402 | * @param $action |
403 | */ | |
00be9182 | 404 | public function setContext($id, $action) { |
6a488035 TO |
405 | $context = CRM_Utils_Request::retrieve('context', 'String', $this); |
406 | ||
407 | //we need to differentiate context for update and preview profile. | |
408 | if (!$context && !($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::PREVIEW))) { | |
409 | $context = 'group'; | |
410 | } | |
411 | ||
412 | if ($context == 'field') { | |
413 | $url = CRM_Utils_System::url('civicrm/admin/uf/group/field', "reset=1&action=browse&gid={$id}"); | |
414 | } | |
415 | else { | |
416 | $url = CRM_Utils_System::url('civicrm/admin/uf/group', 'reset=1&action=browse'); | |
417 | } | |
418 | ||
419 | $session = CRM_Core_Session::singleton(); | |
420 | $session->pushUserContext($url); | |
421 | } | |
422 | ||
624e56fa EM |
423 | /** |
424 | * @param $groupType | |
425 | * | |
426 | * @return array | |
427 | */ | |
00be9182 | 428 | public static function extractGroupTypes($groupType) { |
6a488035 TO |
429 | $returnGroupTypes = array(); |
430 | if (!$groupType) { | |
431 | return $returnGroupTypes; | |
432 | } | |
433 | ||
434 | $groupTypeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $groupType); | |
435 | foreach (explode(',', $groupTypeParts[0]) as $type) { | |
436 | $returnGroupTypes[$type] = $type; | |
437 | } | |
438 | ||
a7488080 | 439 | if (!empty($groupTypeParts[1])) { |
6a488035 TO |
440 | foreach (explode(',', $groupTypeParts[1]) as $typeValue) { |
441 | $groupTypeValues = $valueLabels = array(); | |
442 | $valueParts = explode(':', $typeValue); | |
443 | $typeName = NULL; | |
444 | switch ($valueParts[0]) { | |
445 | case 'ContributionType': | |
446 | $typeName = 'Contribution'; | |
447 | $valueLabels = CRM_Contribute_PseudoConstant::financialType(); | |
448 | break; | |
449 | ||
450 | case 'ParticipantRole': | |
451 | $typeName = 'Participant'; | |
452 | $valueLabels = CRM_Event_PseudoConstant::participantRole(); | |
453 | break; | |
454 | ||
455 | case 'ParticipantEventName': | |
456 | $typeName = 'Participant'; | |
457 | $valueLabels = CRM_Event_PseudoConstant::event(); | |
458 | break; | |
459 | ||
460 | case 'ParticipantEventType': | |
461 | $typeName = 'Participant'; | |
462 | $valueLabels = CRM_Event_PseudoConstant::eventType(); | |
463 | break; | |
464 | ||
465 | case 'MembershipType': | |
466 | $typeName = 'Membership'; | |
467 | $valueLabels = CRM_Member_PseudoConstant::membershipType(); | |
468 | break; | |
469 | ||
470 | case 'ActivityType': | |
471 | $typeName = 'Activity'; | |
472 | $valueLabels = CRM_Core_PseudoConstant::ActivityType(TRUE, TRUE, FALSE, 'label', TRUE); | |
473 | break; | |
1cb28d5d | 474 | case 'CaseType': |
475 | $typeName = 'Case'; | |
476 | $valueLabels = CRM_Case_PseudoConstant::caseType(); | |
477 | break; | |
6a488035 TO |
478 | } |
479 | ||
480 | foreach ($valueParts as $val) { | |
481 | if (CRM_Utils_Rule::integer($val)) { | |
482 | $groupTypeValues[$val] = CRM_Utils_Array::value($val, $valueLabels); | |
483 | } | |
484 | } | |
485 | ||
486 | if (!is_array($returnGroupTypes[$typeName])) { | |
487 | $returnGroupTypes[$typeName] = array(); | |
488 | } | |
489 | $returnGroupTypes[$typeName][$valueParts[0]] = $groupTypeValues; | |
490 | } | |
491 | } | |
492 | return $returnGroupTypes; | |
493 | } | |
494 | } |