CRM/UF/Page/Group.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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
  31  * @copyright CiviCRM LLC (c) 2004-2015
  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
  59    */
  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'),
  71         ),
  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'),
  77         ),
  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'),
  83         ),
  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'),
  89           'fe' => TRUE,
  90         ),
  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'),
  96           'fe' => TRUE,
  97         ),
  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'),
 103           'fe' => TRUE,
 104         ),
 105         CRM_Core_Action::DISABLE => array(
 106           'name' => ts('Disable'),
 107           'ref' => 'crm-enable-disable',
 108           'title' => ts('Disable CiviCRM Profile Group'),
 109         ),
 110         CRM_Core_Action::ENABLE => array(
 111           'name' => ts('Enable'),
 112           'ref' => 'crm-enable-disable',
 113           'title' => ts('Enable CiviCRM Profile Group'),
 114         ),
 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'),
 120         ),
 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'),
 126         ),
 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 . '\');"',
 133         ),
 134       );
 135     }
 136     return self::$_actionLinks;
 137   }
 138
 139   /**
 140    * Run the page.
 141    *
 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.
 145    *
 146    * @param
 147    *
 148    * @return void
 149    */
 150   public function run() {
 151     // get the requested action
 152     $action = CRM_Utils_Request::retrieve('action', 'String',
 153       $this, FALSE,
 154       // default to 'browse'
 155       'browse'
 156     );
 157
 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',
 162       $this, FALSE, 0
 163     );
 164
 165     //set the context and then start w/ action.
 166     $this->setContext($id, $action);
 167
 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);
 171     }
 172     else {
 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);
 176
 177         // update cms integration with registration / my account
 178         CRM_Utils_System::updateCategories();
 179       }
 180       elseif ($action & CRM_Core_Action::PROFILE) {
 181         $this->profile();
 182         CRM_Utils_System::setTitle(ts('%1 - HTML Form Snippet', array(1 => $this->_title)));
 183       }
 184       elseif ($action & CRM_Core_Action::PREVIEW) {
 185         $this->preview($id, $action);
 186       }
 187       elseif ($action & CRM_Core_Action::COPY) {
 188         $this->copy();
 189       }
 190       // finally browse the uf groups
 191       $this->browse();
 192     }
 193     // parent run
 194     return parent::run();
 195   }
 196
 197   /**
 198    * make a copy of a profile, including
 199    * all the fields in the profile
 200    *
 201    * @return void
 202    */
 203   public function copy() {
 204     $gid = CRM_Utils_Request::retrieve('gid', 'Positive',
 205       $this, TRUE, 0, 'GET'
 206     );
 207
 208     CRM_Core_BAO_UFGroup::copy($gid);
 209     CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/uf/group', 'reset=1'));
 210   }
 211
 212   /**
 213    * for profile mode (standalone html form ) for uf group
 214    *
 215    * @return void
 216    */
 217   public function profile() {
 218     $config = CRM_Core_Config::singleton();
 219
 220     // reassign resource base to be the full url, CRM-4660
 221     $config->resourceBase = $config->userFrameworkResourceURL;
 222     $config->useFrameworkRelativeBase = $config->userFrameworkBaseURL;
 223
 224     $gid = CRM_Utils_Request::retrieve('gid', 'Positive',
 225       $this, FALSE, 0, 'GET'
 226     );
 227     $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Edit', ts('Create'), CRM_Core_Action::ADD,
 228       FALSE, FALSE, TRUE
 229     );
 230     $controller->reset();
 231     $controller->process();
 232     $controller->set('gid', $gid);
 233     $controller->setEmbedded(TRUE);
 234     $controller->run();
 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'));
 239
 240     // not sure how to circumvent our own navigation system to generate the right form url
 241     $urlReplaceWith = 'civicrm/profile/create&amp;gid=' . $gid . '&amp;reset=1';
 242     if ($config->userSystem->is_drupal && $config->cleanURL) {
 243       $urlReplaceWith = 'civicrm/profile/create?gid=' . $gid . '&amp;reset=1';
 244     }
 245     $profile = str_replace('civicrm/admin/uf/group', $urlReplaceWith, $profile);
 246
 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);
 251     }
 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;
 256       }
 257       elseif (!empty($config->wpBasePage)) {
 258         $wpbase = $config->wpBasePage;
 259       }
 260       else {
 261         $wpbase = 'index.php';
 262       }
 263       $profile = str_replace('/wp-admin/admin.php', '/' . $wpbase . '/', $profile);
 264     }
 265
 266     // add header files
 267     CRM_Core_Resources::singleton()->addCoreResources('html-header');
 268     $profile = CRM_Core_Region::instance('html-header')->render('', FALSE) . $profile;
 269
 270     $this->assign('profile', htmlentities($profile, ENT_NOQUOTES, 'UTF-8'));
 271     //get the title of uf group
 272     if ($gid) {
 273       $title = CRM_Core_BAO_UFGroup::getTitle($gid);
 274       $this->_title = $title;
 275     }
 276     else {
 277       $title = 'Profile Form';
 278     }
 279
 280     $this->assign('title', $title);
 281     $this->assign('action', CRM_Core_Action::PROFILE);
 282     $this->assign('isForm', 0);
 283   }
 284
 285   /**
 286    * Edit uf group.
 287    *
 288    * @param int $id
 289    *   Uf group id.
 290    * @param string $action
 291    *   The action to be invoked.
 292    *
 293    * @return void
 294    */
 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();
 302     $controller->run();
 303   }
 304
 305   /**
 306    * Browse all uf data groups.
 307    *
 308    * @param
 309    *
 310    * @return void
 311    */
 312   public function browse($action = NULL) {
 313     $ufGroup = array();
 314     $allUFGroups = CRM_Core_BAO_UFGroup::getModuleUFGroup();
 315     if (empty($allUFGroups)) {
 316       return;
 317     }
 318
 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);
 321
 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'];
 332
 333       // form all action links
 334       $action = array_sum(array_keys(self::actionLinks()));
 335
 336       // update enable/disable links depending on uf_group properties.
 337       if ($value['is_active']) {
 338         $action -= CRM_Core_Action::ENABLE;
 339       }
 340       else {
 341         $action -= CRM_Core_Action::DISABLE;
 342       }
 343
 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;
 349       }
 350
 351       $groupTypes = self::extractGroupTypes($value['group_type']);
 352
 353       // drop Create, Edit and View mode links if profile group_type is one of the following:
 354       $groupComponents = array('Contribution', 'Membership', 'Activity', 'Participant', 'Case');
 355       $componentFound = array_intersect($groupComponents, array_keys($groupTypes));
 356       if (!empty($componentFound)) {
 357         $action -= CRM_Core_Action::ADD;
 358       }
 359
 360       $ufGroup[$id]['group_type'] = self::formatGroupTypes($groupTypes);
 361
 362       $ufGroup[$id]['action'] = CRM_Core_Action::formLink(self::actionLinks(), $action,
 363         array('id' => $id),
 364         ts('more'),
 365         FALSE,
 366         'ufGroup.row.actions',
 367         'UFGroup',
 368         $id
 369       );
 370       //get the "Used For" from uf_join
 371       $ufGroup[$id]['module'] = implode(', ', CRM_Core_BAO_UFGroup::getUFJoinRecord($id, TRUE));
 372     }
 373
 374     $this->assign('rows', $ufGroup);
 375   }
 376
 377   /**
 378    * for preview mode for ufoup.
 379    *
 380    * @param int $id
 381    *   Uf group id.
 382    *
 383    * @param int $action
 384    */
 385   public function preview($id, $action) {
 386     $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Preview', ts('CiviCRM Profile Group Preview'), NULL);
 387     $controller->set('id', $id);
 388     $controller->setEmbedded(TRUE);
 389     $controller->process();
 390     $controller->run();
 391   }
 392
 393   /**
 394    * @param int $id
 395    * @param $action
 396    */
 397   public function setContext($id, $action) {
 398     $context = CRM_Utils_Request::retrieve('context', 'String', $this);
 399
 400     //we need to differentiate context for update and preview profile.
 401     if (!$context && !($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::PREVIEW))) {
 402       $context = 'group';
 403     }
 404
 405     if ($context == 'field') {
 406       $url = CRM_Utils_System::url('civicrm/admin/uf/group/field', "reset=1&action=browse&gid={$id}");
 407     }
 408     else {
 409       $url = CRM_Utils_System::url('civicrm/admin/uf/group', 'reset=1&action=browse');
 410     }
 411
 412     $session = CRM_Core_Session::singleton();
 413     $session->pushUserContext($url);
 414   }
 415
 416   /**
 417    * @param $groupType
 418    *
 419    * @return array
 420    */
 421   public static function extractGroupTypes($groupType) {
 422     $returnGroupTypes = array();
 423     if (!$groupType) {
 424       return $returnGroupTypes;
 425     }
 426
 427     $groupTypeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $groupType);
 428     foreach (explode(',', $groupTypeParts[0]) as $type) {
 429       $returnGroupTypes[$type] = $type;
 430     }
 431
 432     if (!empty($groupTypeParts[1])) {
 433       foreach (explode(',', $groupTypeParts[1]) as $typeValue) {
 434         $groupTypeValues = $valueLabels = array();
 435         $valueParts = explode(':', $typeValue);
 436         $typeName = NULL;
 437         switch ($valueParts[0]) {
 438           case 'ContributionType':
 439             $typeName = 'Contribution';
 440             $valueLabels = CRM_Contribute_PseudoConstant::financialType();
 441             break;
 442
 443           case 'ParticipantRole':
 444             $typeName = 'Participant';
 445             $valueLabels = CRM_Event_PseudoConstant::participantRole();
 446             break;
 447
 448           case 'ParticipantEventName':
 449             $typeName = 'Participant';
 450             $valueLabels = CRM_Event_PseudoConstant::event();
 451             break;
 452
 453           case 'ParticipantEventType':
 454             $typeName = 'Participant';
 455             $valueLabels = CRM_Event_PseudoConstant::eventType();
 456             break;
 457
 458           case 'MembershipType':
 459             $typeName = 'Membership';
 460             $valueLabels = CRM_Member_PseudoConstant::membershipType();
 461             break;
 462
 463           case 'ActivityType':
 464             $typeName = 'Activity';
 465             $valueLabels = CRM_Core_PseudoConstant::ActivityType(TRUE, TRUE, FALSE, 'label', TRUE);
 466             break;
 467
 468           case 'CaseType':
 469             $typeName = 'Case';
 470             $valueLabels = CRM_Case_PseudoConstant::caseType();
 471             break;
 472         }
 473
 474         foreach ($valueParts as $val) {
 475           if (CRM_Utils_Rule::integer($val)) {
 476             $groupTypeValues[$val] = CRM_Utils_Array::value($val, $valueLabels);
 477           }
 478         }
 479
 480         if (!is_array($returnGroupTypes[$typeName])) {
 481           $returnGroupTypes[$typeName] = array();
 482         }
 483         $returnGroupTypes[$typeName][$valueParts[0]] = $groupTypeValues;
 484       }
 485     }
 486     return $returnGroupTypes;
 487   }
 488
 489   /**
 490    * Format 'group_type' field for display
 491    *
 492    * @param array $groupTypes
 493    *   output from self::extractGroupTypes
 494    * @return string
 495    */
 496   public static function formatGroupTypes($groupTypes) {
 497     $groupTypesString = '';
 498     if (!empty($groupTypes)) {
 499       $groupTypesStrings = array();
 500       foreach ($groupTypes as $groupType => $typeValues) {
 501         if (is_array($typeValues)) {
 502           if ($groupType == 'Participant') {
 503             foreach ($typeValues as $subType => $subTypeValues) {
 504               $groupTypesStrings[] = $subType . '::' . implode(': ', $subTypeValues);
 505             }
 506           }
 507           else {
 508             $groupTypesStrings[] = $groupType . '::' . implode(': ', current($typeValues));
 509           }
 510         }
 511         else {
 512           $groupTypesStrings[] = $groupType;
 513         }
 514       }
 515       $groupTypesString = implode(', ', $groupTypesStrings);
 516     }
 517     return $groupTypesString;
 518   }
 519
 520 }