CRM/Group/Form/Edit.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  */
  33
  34 /**
  35  * This class is to build the form for adding Group.
  36  */
  37 class CRM_Group_Form_Edit extends CRM_Core_Form {
  38
  39   /**
  40    * The group id, used when editing a group
  41    *
  42    * @var int
  43    */
  44   protected $_id;
  45
  46   /**
  47    * The group object, if an id is present
  48    *
  49    * @var object
  50    */
  51   protected $_group;
  52
  53   /**
  54    * The title of the group being deleted
  55    *
  56    * @var string
  57    */
  58   protected $_title;
  59
  60   /**
  61    * Store the group values
  62    *
  63    * @var array
  64    */
  65   protected $_groupValues;
  66
  67   /**
  68    * What blocks should we show and hide.
  69    *
  70    * @var CRM_Core_ShowHideBlocks
  71    */
  72   protected $_showHide;
  73
  74   /**
  75    * The civicrm_group_organization table id
  76    *
  77    * @var int
  78    */
  79   protected $_groupOrganizationID;
  80
  81   /**
  82    * Set up variables to build the form.
  83    */
  84   public function preProcess() {
  85     $this->_id = $this->get('id');
  86     if ($this->_id) {
  87       $breadCrumb = array(
  88         array(
  89           'title' => ts('Manage Groups'),
  90           'url' => CRM_Utils_System::url('civicrm/group',
  91             'reset=1'
  92           ),
  93         ),
  94       );
  95       CRM_Utils_System::appendBreadCrumb($breadCrumb);
  96
  97       $this->_groupValues = array();
  98       $params = array('id' => $this->_id);
  99       $this->_group = CRM_Contact_BAO_Group::retrieve($params, $this->_groupValues);
 100       $this->_title = $this->_groupValues['title'];
 101     }
 102
 103     $this->assign('action', $this->_action);
 104     $this->assign('showBlockJS', TRUE);
 105
 106     if ($this->_action == CRM_Core_Action::DELETE) {
 107       if (isset($this->_id)) {
 108         $this->assign('title', $this->_title);
 109         $this->assign('count', CRM_Contact_BAO_Group::memberCount($this->_id));
 110         CRM_Utils_System::setTitle(ts('Confirm Group Delete'));
 111       }
 112       if ($this->_groupValues['is_reserved'] == 1 && !CRM_Core_Permission::check('administer reserved groups')) {
 113         CRM_Core_Error::statusBounce(ts("You do not have sufficient permission to delete this reserved group."));
 114       }
 115     }
 116     else {
 117       if ($this->_groupValues['is_reserved'] == 1 && !CRM_Core_Permission::check('administer reserved groups')) {
 118         CRM_Core_Error::statusBounce(ts("You do not have sufficient permission to change settings for this reserved group."));
 119       }
 120       if (isset($this->_id)) {
 121         $groupValues = array(
 122           'id' => $this->_id,
 123           'title' => $this->_title,
 124           'saved_search_id' => isset($this->_groupValues['saved_search_id']) ? $this->_groupValues['saved_search_id'] : '',
 125         );
 126         if (isset($this->_groupValues['saved_search_id'])) {
 127           $groupValues['mapping_id'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch',
 128             $this->_groupValues['saved_search_id'],
 129             'mapping_id'
 130           );
 131           $groupValues['search_custom_id'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch',
 132             $this->_groupValues['saved_search_id'],
 133             'search_custom_id'
 134           );
 135         }
 136         if (!empty($this->_groupValues['created_id'])) {
 137           $groupValues['created_by'] = CRM_Core_DAO::getFieldValue("CRM_Contact_DAO_Contact", $this->_groupValues['created_id'], 'sort_name', 'id');
 138         }
 139
 140         if (!empty($this->_groupValues['modified_id'])) {
 141           $groupValues['modified_by'] = CRM_Core_DAO::getFieldValue("CRM_Contact_DAO_Contact", $this->_groupValues['modified_id'], 'sort_name', 'id');
 142         }
 143
 144         $this->assign_by_ref('group', $groupValues);
 145
 146         CRM_Utils_System::setTitle(ts('Group Settings: %1', array(1 => $this->_title)));
 147       }
 148       $session = CRM_Core_Session::singleton();
 149       $session->pushUserContext(CRM_Utils_System::url('civicrm/group', 'reset=1'));
 150     }
 151
 152     //build custom data
 153     CRM_Custom_Form_CustomData::preProcess($this, NULL, NULL, 1, 'Group', $this->_id);
 154   }
 155
 156   /**
 157    * Set default values for the form.
 158    *
 159    * @return array
 160    */
 161   public function setDefaultValues() {
 162     $defaults = array();
 163
 164     if (isset($this->_id)) {
 165       $defaults = $this->_groupValues;
 166       if (!empty($defaults['group_type'])) {
 167         $types = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 168           substr($defaults['group_type'], 1, -1)
 169         );
 170         $defaults['group_type'] = array();
 171         foreach ($types as $type) {
 172           $defaults['group_type'][$type] = 1;
 173         }
 174       }
 175
 176       if (CRM_Core_Permission::check('administer Multiple Organizations') && CRM_Core_Permission::isMultisiteEnabled()) {
 177         CRM_Contact_BAO_GroupOrganization::retrieve($this->_id, $defaults);
 178       }
 179     }
 180
 181     if (!((CRM_Core_Permission::check('access CiviMail')) ||
 182       (CRM_Mailing_Info::workflowEnabled() &&
 183         CRM_Core_Permission::check('create mailings')
 184       )
 185     )
 186     ) {
 187       $groupTypes = CRM_Core_OptionGroup::values('group_type', TRUE);
 188       if ($defaults['group_type'][$groupTypes['Mailing List']] == 1) {
 189         $this->assign('freezeMailignList', $groupTypes['Mailing List']);
 190       }
 191       else {
 192         $this->assign('hideMailignList', $groupTypes['Mailing List']);
 193       }
 194     }
 195
 196     if (empty($defaults['parents'])) {
 197       $defaults['parents'] = CRM_Core_BAO_Domain::getGroupId();
 198     }
 199
 200     // custom data set defaults
 201     $defaults += CRM_Custom_Form_CustomData::setDefaultValues($this);
 202     return $defaults;
 203   }
 204
 205   /**
 206    * Build the form object.
 207    */
 208   public function buildQuickForm() {
 209     if ($this->_action == CRM_Core_Action::DELETE) {
 210       $this->addButtons(array(
 211           array(
 212             'type' => 'next',
 213             'name' => ts('Delete Group'),
 214             'isDefault' => TRUE,
 215           ),
 216           array(
 217             'type' => 'cancel',
 218             'name' => ts('Cancel'),
 219           ),
 220         )
 221       );
 222       return;
 223     }
 224
 225     // We want the "new group" form to redirect the user
 226     if ($this->_action == CRM_Core_Action::ADD) {
 227       $this->preventAjaxSubmit();
 228     }
 229
 230     $this->applyFilter('__ALL__', 'trim');
 231     $this->add('text', 'title', ts('Name') . ' ',
 232       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Group', 'title'), TRUE
 233     );
 234
 235     $this->add('textarea', 'description', ts('Description') . ' ',
 236       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Group', 'description')
 237     );
 238
 239     $groupTypes = CRM_Core_OptionGroup::values('group_type', TRUE);
 240     $config = CRM_Core_Config::singleton();
 241     if (isset($this->_id) && !empty($this->_groupValues['saved_search_id'])) {
 242       unset($groupTypes['Access Control']);
 243     }
 244
 245     if (!empty($groupTypes)) {
 246       $this->addCheckBox('group_type',
 247         ts('Group Type'),
 248         $groupTypes,
 249         NULL, NULL, NULL, NULL, '&nbsp;&nbsp;&nbsp;'
 250       );
 251     }
 252
 253     $this->add('select', 'visibility', ts('Visibility'), CRM_Core_SelectValues::groupVisibility(), TRUE);
 254
 255     //CRM-14190
 256     $parentGroups = self::buildParentGroups($this);
 257
 258     if (CRM_Core_Permission::check('administer Multiple Organizations') && CRM_Core_Permission::isMultisiteEnabled()) {
 259       //group organization Element
 260       $props = array('api' => array('params' => array('contact_type' => 'Organization')));
 261       $this->addEntityRef('organization_id', ts('Organization'), $props);
 262     }
 263
 264     // is_reserved property CRM-9936
 265     $this->addElement('checkbox', 'is_reserved', ts('Reserved Group?'));
 266     if (!CRM_Core_Permission::check('administer reserved groups')) {
 267       $this->freeze('is_reserved');
 268     }
 269
 270     //build custom data
 271     CRM_Custom_Form_CustomData::buildQuickForm($this);
 272
 273     $this->addButtons(array(
 274         array(
 275           'type' => 'upload',
 276           'name' => ($this->_action == CRM_Core_Action::ADD) ? ts('Continue') : ts('Save'),
 277           'isDefault' => TRUE,
 278         ),
 279         array(
 280           'type' => 'cancel',
 281           'name' => ts('Cancel'),
 282         ),
 283       )
 284     );
 285
 286     $doParentCheck = FALSE;
 287     if (CRM_Core_Permission::isMultisiteEnabled()) {
 288       $doParentCheck = ($this->_id && CRM_Core_BAO_Domain::isDomainGroup($this->_id)) ? FALSE : TRUE;
 289     }
 290
 291     $options = array(
 292       'selfObj' => $this,
 293       'parentGroups' => $parentGroups,
 294       'doParentCheck' => $doParentCheck,
 295     );
 296     $this->addFormRule(array('CRM_Group_Form_Edit', 'formRule'), $options);
 297   }
 298
 299   /**
 300    * Global validation rules for the form.
 301    *
 302    * @param array $fields
 303    *   Posted values of the form.
 304    * @param array $fileParams
 305    * @param array $options
 306    *
 307    * @return array
 308    *   list of errors to be posted back to the form
 309    */
 310   public static function formRule($fields, $fileParams, $options) {
 311     $errors = array();
 312
 313     $doParentCheck = $options['doParentCheck'];
 314     $self = &$options['selfObj'];
 315
 316     if ($doParentCheck) {
 317       $parentGroups = $options['parentGroups'];
 318
 319       $grpRemove = 0;
 320       foreach ($fields as $key => $val) {
 321         if (substr($key, 0, 20) == 'remove_parent_group_') {
 322           $grpRemove++;
 323         }
 324       }
 325
 326       $grpAdd = 0;
 327       if (!empty($fields['parents'])) {
 328         $grpAdd++;
 329       }
 330
 331       if ((count($parentGroups) >= 1) && (($grpRemove - $grpAdd) >= count($parentGroups))) {
 332         $errors['parents'] = ts('Make sure at least one parent group is set.');
 333       }
 334     }
 335
 336     // do check for both name and title uniqueness
 337     if (!empty($fields['title'])) {
 338       $title = trim($fields['title']);
 339       $query = "
 340 SELECT count(*)
 341 FROM   civicrm_group
 342 WHERE  title = %1
 343 ";
 344       $params = array(1 => array($title, 'String'));
 345
 346       if ($self->_id) {
 347         $query .= "AND id <> %2";
 348         $params[2] = array($self->_id, 'Integer');
 349       }
 350
 351       $grpCnt = CRM_Core_DAO::singleValueQuery($query, $params);
 352       if ($grpCnt) {
 353         $errors['title'] = ts('Group \'%1\' already exists.', array(1 => $fields['title']));
 354       }
 355     }
 356
 357     return empty($errors) ? TRUE : $errors;
 358   }
 359
 360   /**
 361    * Process the form when submitted.
 362    */
 363   public function postProcess() {
 364     CRM_Utils_System::flushCache('CRM_Core_DAO_Group');
 365
 366     $updateNestingCache = FALSE;
 367     if ($this->_action & CRM_Core_Action::DELETE) {
 368       CRM_Contact_BAO_Group::discard($this->_id);
 369       CRM_Core_Session::setStatus(ts("The Group '%1' has been deleted.", array(1 => $this->_title)), ts('Group Deleted'), 'success');
 370       $updateNestingCache = TRUE;
 371     }
 372     else {
 373       // store the submitted values in an array
 374       $params = $this->controller->exportValues($this->_name);
 375
 376       $params['is_active'] = CRM_Utils_Array::value('is_active', $this->_groupValues, 1);
 377
 378       if ($this->_action & CRM_Core_Action::UPDATE) {
 379         $params['id'] = $this->_id;
 380       }
 381
 382       if ($this->_action & CRM_Core_Action::UPDATE && isset($this->_groupOrganizationID)) {
 383         $params['group_organization'] = $this->_groupOrganizationID;
 384       }
 385
 386       $params['is_reserved'] = CRM_Utils_Array::value('is_reserved', $params, FALSE);
 387
 388       $customFields = CRM_Core_BAO_CustomField::getFields('Group');
 389       $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 390         $this->_id,
 391         'Group'
 392       );
 393
 394       $group = CRM_Contact_BAO_Group::create($params);
 395
 396       //Remove any parent groups requested to be removed
 397       if (!empty($this->_groupValues['parents'])) {
 398         $parentGroupIds = explode(',', $this->_groupValues['parents']);
 399         foreach ($parentGroupIds as $parentGroupId) {
 400           if (isset($params["remove_parent_group_$parentGroupId"])) {
 401             CRM_Contact_BAO_GroupNesting::remove($parentGroupId, $group->id);
 402             $updateNestingCache = TRUE;
 403           }
 404         }
 405       }
 406
 407       CRM_Core_Session::setStatus(ts('The Group \'%1\' has been saved.', array(1 => $group->title)), ts('Group Saved'), 'success');
 408
 409       // Add context to the session, in case we are adding members to the group
 410       if ($this->_action & CRM_Core_Action::ADD) {
 411         $this->set('context', 'amtg');
 412         $this->set('amtgID', $group->id);
 413
 414         $session = CRM_Core_Session::singleton();
 415         $session->pushUserContext(CRM_Utils_System::url('civicrm/group/search', 'reset=1&force=1&context=smog&gid=' . $group->id));
 416       }
 417     }
 418
 419     // update the nesting cache
 420     if ($updateNestingCache) {
 421       CRM_Contact_BAO_GroupNestingCache::update();
 422     }
 423   }
 424
 425   /**
 426    * Build parent groups form elements.
 427    *
 428    * @param CRM_Core_Form $form
 429    *
 430    * @return array
 431    *   parent groups
 432    */
 433   public static function buildParentGroups(&$form) {
 434     $groupNames = CRM_Core_PseudoConstant::group();
 435     $parentGroups = $parentGroupElements = array();
 436     if (isset($form->_id) && !empty($form->_groupValues['parents'])) {
 437       $parentGroupIds = explode(',', $form->_groupValues['parents']);
 438       foreach ($parentGroupIds as $parentGroupId) {
 439         $parentGroups[$parentGroupId] = $groupNames[$parentGroupId];
 440         if (array_key_exists($parentGroupId, $groupNames)) {
 441           $parentGroupElements[$parentGroupId] = $groupNames[$parentGroupId];
 442           $form->addElement('checkbox', "remove_parent_group_$parentGroupId",
 443             $groupNames[$parentGroupId]
 444           );
 445         }
 446       }
 447     }
 448     $form->assign_by_ref('parent_groups', $parentGroupElements);
 449
 450     if (isset($form->_id)) {
 451       $potentialParentGroupIds = CRM_Contact_BAO_GroupNestingCache::getPotentialCandidates($form->_id, $groupNames);
 452     }
 453     else {
 454       $potentialParentGroupIds = array_keys($groupNames);
 455     }
 456
 457     $parentGroupSelectValues = array('' => '- ' . ts('select group') . ' -');
 458     foreach ($potentialParentGroupIds as $potentialParentGroupId) {
 459       if (array_key_exists($potentialParentGroupId, $groupNames)) {
 460         $parentGroupSelectValues[$potentialParentGroupId] = $groupNames[$potentialParentGroupId];
 461       }
 462     }
 463
 464     if (count($parentGroupSelectValues) > 1) {
 465       if (CRM_Core_Permission::isMultisiteEnabled()) {
 466         $required = !isset($form->_id) || ($form->_id && CRM_Core_BAO_Domain::isDomainGroup($form->_id)) ? FALSE : empty($parentGroups);
 467       }
 468       else {
 469         $required = FALSE;
 470       }
 471       $form->add('select', 'parents', ts('Add Parent'), $parentGroupSelectValues, $required, array('class' => 'crm-select2'));
 472     }
 473
 474     return $parentGroups;
 475   }
 476
 477 }