CRM/Group/Form/Edit.php

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