3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
37 * Create a page for displaying UF Groups.
39 * Heart of this class is the run method which checks
40 * for action type and then displays the appropriate
44 class CRM_UF_Page_Group
extends CRM_Core_Page
{
47 * The action links that we need to display for the browse screen.
51 private static $_actionLinks = NULL;
54 * Get the action links for this page.
60 public static function &actionLinks() {
61 // check if variable _actionsLinks is populated
62 if (!self
::$_actionLinks) {
63 // helper variable for nicer formatting
64 $copyExtra = ts('Are you sure you want to make a copy of this Profile?');
65 self
::$_actionLinks = array(
66 CRM_Core_Action
::BROWSE
=> array(
67 'name' => ts('Fields'),
68 'url' => 'civicrm/admin/uf/group/field',
69 'qs' => 'reset=1&action=browse&gid=%%id%%',
70 'title' => ts('View and Edit Fields'),
72 CRM_Core_Action
::UPDATE
=> array(
73 'name' => ts('Settings'),
74 'url' => 'civicrm/admin/uf/group/update',
75 'qs' => 'action=update&id=%%id%%&context=group',
76 'title' => ts('Edit CiviCRM Profile Group'),
78 CRM_Core_Action
::PREVIEW
=> array(
79 'name' => ts('Preview'),
80 'url' => 'civicrm/admin/uf/group',
81 'qs' => 'action=preview&id=%%id%%&field=0&context=group',
82 'title' => ts('Edit CiviCRM Profile Group'),
84 CRM_Core_Action
::ADD
=> array(
85 'name' => ts('Use - Create Mode'),
86 'url' => 'civicrm/profile/create',
87 'qs' => 'gid=%%id%%&reset=1',
88 'title' => ts('Use - Create Mode'),
91 CRM_Core_Action
::ADVANCED
=> array(
92 'name' => ts('Use - Edit Mode'),
93 'url' => 'civicrm/profile/edit',
94 'qs' => 'gid=%%id%%&reset=1',
95 'title' => ts('Use - Edit Mode'),
98 CRM_Core_Action
::BASIC
=> array(
99 'name' => ts('Use - Listings Mode'),
100 'url' => 'civicrm/profile',
101 'qs' => 'gid=%%id%%&reset=1',
102 'title' => ts('Use - Listings Mode'),
105 CRM_Core_Action
::DISABLE
=> array(
106 'name' => ts('Disable'),
107 'ref' => 'crm-enable-disable',
108 'title' => ts('Disable CiviCRM Profile Group'),
110 CRM_Core_Action
::ENABLE
=> array(
111 'name' => ts('Enable'),
112 'ref' => 'crm-enable-disable',
113 'title' => ts('Enable CiviCRM Profile Group'),
115 CRM_Core_Action
::DELETE
=> array(
116 'name' => ts('Delete'),
117 'url' => 'civicrm/admin/uf/group',
118 'qs' => 'action=delete&id=%%id%%',
119 'title' => ts('Delete CiviCRM Profile Group'),
121 CRM_Core_Action
::PROFILE
=> array(
122 'name' => ts('HTML Form Snippet'),
123 'url' => 'civicrm/admin/uf/group',
124 'qs' => 'action=profile&gid=%%id%%',
125 'title' => ts('HTML Form Snippet for this Profile'),
127 CRM_Core_Action
::COPY
=> array(
128 'name' => ts('Copy'),
129 'url' => 'civicrm/admin/uf/group',
130 'qs' => 'action=copy&gid=%%id%%',
131 'title' => ts('Make a Copy of CiviCRM Profile Group'),
132 'extra' => 'onclick = "return confirm(\'' . $copyExtra . '\');"',
136 return self
::$_actionLinks;
142 * This method is called after the page is created. It checks for the
143 * type of action and executes that action.
144 * Finally it calls the parent's run method.
150 public function run() {
151 // get the requested action
152 $action = CRM_Utils_Request
::retrieve('action', 'String',
154 // default to 'browse'
158 // assign vars to templates
159 $this->assign('action', $action);
160 $this->assign('selectedChild', CRM_Utils_Request
::retrieve('selectedChild', 'String', $this));
161 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
165 //set the context and then start w/ action.
166 $this->setContext($id, $action);
168 // what action to take ?
169 if ($action & (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD | CRM_Core_Action
::DELETE | CRM_Core_Action
::DISABLE
)) {
170 $this->edit($id, $action);
173 // if action is enable or disable do the needful.
174 if ($action & CRM_Core_Action
::ENABLE
) {
175 CRM_Core_BAO_UFGroup
::setIsActive($id, 1);
177 // update cms integration with registration / my account
178 CRM_Utils_System
::updateCategories();
180 elseif ($action & CRM_Core_Action
::PROFILE
) {
182 CRM_Utils_System
::setTitle(ts('%1 - HTML Form Snippet', array(1 => $this->_title
)));
184 elseif ($action & CRM_Core_Action
::PREVIEW
) {
185 $this->preview($id, $action);
187 elseif ($action & CRM_Core_Action
::COPY
) {
190 // finally browse the uf groups
194 return parent
::run();
198 * make a copy of a profile, including
199 * all the fields in the profile
203 public function copy() {
204 $gid = CRM_Utils_Request
::retrieve('gid', 'Positive',
205 $this, TRUE, 0, 'GET'
208 CRM_Core_BAO_UFGroup
::copy($gid);
209 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/uf/group', 'reset=1'));
213 * for profile mode (standalone html form ) for uf group
217 public function profile() {
218 $config = CRM_Core_Config
::singleton();
220 // reassign resource base to be the full url, CRM-4660
221 $config->resourceBase
= $config->userFrameworkResourceURL
;
222 $config->useFrameworkRelativeBase
= $config->userFrameworkBaseURL
;
224 $gid = CRM_Utils_Request
::retrieve('gid', 'Positive',
225 $this, FALSE, 0, 'GET'
227 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Edit', ts('Create'), CRM_Core_Action
::ADD
,
230 $controller->reset();
231 $controller->process();
232 $controller->set('gid', $gid);
233 $controller->setEmbedded(TRUE);
235 $template = CRM_Core_Smarty
::singleton();
236 $template->assign('gid', $gid);
237 $template->assign('tplFile', 'CRM/Profile/Form/Edit.tpl');
238 $profile = trim($template->fetch('CRM/Form/default.tpl'));
240 // not sure how to circumvent our own navigation system to generate the right form url
241 $urlReplaceWith = 'civicrm/profile/create&gid=' . $gid . '&reset=1';
242 if ($config->userSystem
->is_drupal
&& $config->cleanURL
) {
243 $urlReplaceWith = 'civicrm/profile/create?gid=' . $gid . '&reset=1';
245 $profile = str_replace('civicrm/admin/uf/group', $urlReplaceWith, $profile);
247 // FIXME: (CRM-3587) hack to make standalone profile work
248 // in wordpress and joomla without administrator login
249 if ($config->userFramework
== 'Joomla') {
250 $profile = str_replace('/administrator/', '/index.php', $profile);
252 elseif ($config->userFramework
== 'WordPress') {
253 //@todo remove this part when it is OK to deprecate CIVICRM_UF_WP_BASEPAGE-CRM-15933
254 if (defined('CIVICRM_UF_WP_BASEPAGE')) {
255 $wpbase = CIVICRM_UF_WP_BASEPAGE
;
257 elseif (!empty($config->wpBasePage
)) {
258 $wpbase = $config->wpBasePage
;
261 $wpbase = 'index.php';
263 $profile = str_replace('/wp-admin/admin.php', '/' . $wpbase . '/', $profile);
267 CRM_Core_Resources
::singleton()->addCoreResources('html-header');
268 $profile = CRM_Core_Region
::instance('html-header')->render('', FALSE) . $profile;
270 $this->assign('profile', htmlentities($profile, ENT_NOQUOTES
, 'UTF-8'));
271 //get the title of uf group
273 $title = CRM_Core_BAO_UFGroup
::getTitle($gid);
274 $this->_title
= $title;
277 $title = 'Profile Form';
280 $this->assign('title', $title);
281 $this->assign('action', CRM_Core_Action
::PROFILE
);
282 $this->assign('isForm', 0);
290 * @param string $action
291 * The action to be invoked.
295 public function edit($id, $action) {
296 // create a simple controller for editing uf data
297 $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Group', ts('CiviCRM Profile Group'), $action);
298 $this->setContext($id, $action);
299 $controller->set('id', $id);
300 $controller->setEmbedded(TRUE);
301 $controller->process();
306 * Browse all uf data groups.
312 public function browse($action = NULL) {
314 $allUFGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup();
315 if (empty($allUFGroups)) {
319 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
320 CRM_Utils_Hook
::aclGroup(CRM_Core_Permission
::ADMIN
, NULL, 'civicrm_uf_group', $ufGroups, $allUFGroups);
322 foreach ($allUFGroups as $id => $value) {
323 $ufGroup[$id] = array();
324 $ufGroup[$id]['id'] = $id;
325 $ufGroup[$id]['title'] = $value['title'];
326 $ufGroup[$id]['created_id'] = $value['created_id'];
327 $ufGroup[$id]['created_by'] = CRM_Contact_BAO_Contact
::displayName($value['created_id']);
328 $ufGroup[$id]['description'] = $value['description'];
329 $ufGroup[$id]['is_active'] = $value['is_active'];
330 $ufGroup[$id]['group_type'] = $value['group_type'];
331 $ufGroup[$id]['is_reserved'] = $value['is_reserved'];
333 // form all action links
334 $action = array_sum(array_keys(self
::actionLinks()));
336 // update enable/disable links depending on uf_group properties.
337 if ($value['is_active']) {
338 $action -= CRM_Core_Action
::ENABLE
;
341 $action -= CRM_Core_Action
::DISABLE
;
344 // drop certain actions if the profile is reserved
345 if ($value['is_reserved']) {
346 $action -= CRM_Core_Action
::UPDATE
;
347 $action -= CRM_Core_Action
::DISABLE
;
348 $action -= CRM_Core_Action
::DELETE
;
351 $groupTypes = self
::extractGroupTypes($value['group_type']);
353 // drop Create, Edit and View mode links if profile group_type is one of the following:
354 // Contribution, Membership, Activity, Participant, Case, Grant
355 $isMixedProfile = CRM_Core_BAO_UFField
::checkProfileType($id);
356 if ($isMixedProfile) {
357 $action -= CRM_Core_Action
::ADD
;
358 $action -= CRM_Core_Action
::ADVANCED
;
359 $action -= CRM_Core_Action
::BASIC
;
360 $action -= CRM_Core_Action
::PROFILE
;
363 $ufGroup[$id]['group_type'] = self
::formatGroupTypes($groupTypes);
365 $ufGroup[$id]['action'] = CRM_Core_Action
::formLink(self
::actionLinks(), $action,
369 'ufGroup.row.actions',
373 //get the "Used For" from uf_join
374 $ufGroup[$id]['module'] = implode(', ', CRM_Core_BAO_UFGroup
::getUFJoinRecord($id, TRUE));
377 $this->assign('rows', $ufGroup);
381 * for preview mode for ufoup.
388 public function preview($id, $action) {
389 $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Preview', ts('CiviCRM Profile Group Preview'), NULL);
390 $controller->set('id', $id);
391 $controller->setEmbedded(TRUE);
392 $controller->process();
400 public function setContext($id, $action) {
401 $context = CRM_Utils_Request
::retrieve('context', 'String', $this);
403 //we need to differentiate context for update and preview profile.
404 if (!$context && !($action & (CRM_Core_Action
::UPDATE | CRM_Core_Action
::PREVIEW
))) {
408 if ($context == 'field') {
409 $url = CRM_Utils_System
::url('civicrm/admin/uf/group/field', "reset=1&action=browse&gid={$id}");
412 $url = CRM_Utils_System
::url('civicrm/admin/uf/group', 'reset=1&action=browse');
415 $session = CRM_Core_Session
::singleton();
416 $session->pushUserContext($url);
424 public static function extractGroupTypes($groupType) {
425 $returnGroupTypes = array();
427 return $returnGroupTypes;
430 $groupTypeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $groupType);
431 foreach (explode(',', $groupTypeParts[0]) as $type) {
432 $returnGroupTypes[$type] = $type;
435 if (!empty($groupTypeParts[1])) {
436 foreach (explode(',', $groupTypeParts[1]) as $typeValue) {
437 $groupTypeValues = $valueLabels = array();
438 $valueParts = explode(':', $typeValue);
440 switch ($valueParts[0]) {
441 case 'ContributionType':
442 $typeName = 'Contribution';
443 $valueLabels = CRM_Contribute_PseudoConstant
::financialType();
446 case 'ParticipantRole':
447 $typeName = 'Participant';
448 $valueLabels = CRM_Event_PseudoConstant
::participantRole();
451 case 'ParticipantEventName':
452 $typeName = 'Participant';
453 $valueLabels = CRM_Event_PseudoConstant
::event();
456 case 'ParticipantEventType':
457 $typeName = 'Participant';
458 $valueLabels = CRM_Event_PseudoConstant
::eventType();
461 case 'MembershipType':
462 $typeName = 'Membership';
463 $valueLabels = CRM_Member_PseudoConstant
::membershipType();
467 $typeName = 'Activity';
468 $valueLabels = CRM_Core_PseudoConstant
::ActivityType(TRUE, TRUE, FALSE, 'label', TRUE);
473 $valueLabels = CRM_Case_PseudoConstant
::caseType();
477 foreach ($valueParts as $val) {
478 if (CRM_Utils_Rule
::integer($val)) {
479 $groupTypeValues[$val] = CRM_Utils_Array
::value($val, $valueLabels);
483 if (!is_array($returnGroupTypes[$typeName])) {
484 $returnGroupTypes[$typeName] = array();
486 $returnGroupTypes[$typeName][$valueParts[0]] = $groupTypeValues;
489 return $returnGroupTypes;
493 * Format 'group_type' field for display
495 * @param array $groupTypes
496 * output from self::extractGroupTypes
499 public static function formatGroupTypes($groupTypes) {
500 $groupTypesString = '';
501 if (!empty($groupTypes)) {
502 $groupTypesStrings = array();
503 foreach ($groupTypes as $groupType => $typeValues) {
504 if (is_array($typeValues)) {
505 if ($groupType == 'Participant') {
506 foreach ($typeValues as $subType => $subTypeValues) {
507 $groupTypesStrings[] = $subType . '::' . implode(': ', $subTypeValues);
511 $groupTypesStrings[] = $groupType . '::' . implode(': ', current($typeValues));
515 $groupTypesStrings[] = $groupType;
518 $groupTypesString = implode(', ', $groupTypesStrings);
520 return $groupTypesString;