3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
35 * This class is to build the form for adding Group.
37 class CRM_Group_Form_Edit
extends CRM_Core_Form
{
40 * The group id, used when editing a group
47 * The group object, if an id is present
54 * The title of the group being deleted
61 * Store the group values
65 protected $_groupValues;
68 * What blocks should we show and hide.
70 * @var CRM_Core_ShowHideBlocks
75 * The civicrm_group_organization table id
79 protected $_groupOrganizationID;
82 * Set up variables to build the form.
84 public function preProcess() {
85 $this->_id
= $this->get('id');
89 'title' => ts('Manage Groups'),
90 'url' => CRM_Utils_System
::url('civicrm/group',
95 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
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'];
103 $this->assign('action', $this->_action
);
104 $this->assign('showBlockJS', TRUE);
106 if ($this->_action
== CRM_Core_Action
::DELETE
) {
107 if (isset($this->_id
)) {
108 $this->assign('title', $this->_title
);
110 $this->assign('count', CRM_Contact_BAO_Group
::memberCount($this->_id
));
112 catch (CRM_Core_Exception
$e) {
113 // If the group is borked the query might fail but delete should be possible.
115 CRM_Utils_System
::setTitle(ts('Confirm Group Delete'));
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 delete this reserved group."));
122 if ($this->_groupValues
['is_reserved'] == 1 && !CRM_Core_Permission
::check('administer reserved groups')) {
123 CRM_Core_Error
::statusBounce(ts("You do not have sufficient permission to change settings for this reserved group."));
125 if (isset($this->_id
)) {
126 $groupValues = array(
128 'title' => $this->_title
,
129 'saved_search_id' => isset($this->_groupValues
['saved_search_id']) ?
$this->_groupValues
['saved_search_id'] : '',
131 if (isset($this->_groupValues
['saved_search_id'])) {
132 $groupValues['mapping_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch',
133 $this->_groupValues
['saved_search_id'],
136 $groupValues['search_custom_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch',
137 $this->_groupValues
['saved_search_id'],
141 if (!empty($this->_groupValues
['created_id'])) {
142 $groupValues['created_by'] = CRM_Core_DAO
::getFieldValue("CRM_Contact_DAO_Contact", $this->_groupValues
['created_id'], 'sort_name', 'id');
145 if (!empty($this->_groupValues
['modified_id'])) {
146 $groupValues['modified_by'] = CRM_Core_DAO
::getFieldValue("CRM_Contact_DAO_Contact", $this->_groupValues
['modified_id'], 'sort_name', 'id');
149 $this->assign_by_ref('group', $groupValues);
151 CRM_Utils_System
::setTitle(ts('Group Settings: %1', array(1 => $this->_title
)));
153 $session = CRM_Core_Session
::singleton();
154 $session->pushUserContext(CRM_Utils_System
::url('civicrm/group', 'reset=1'));
158 CRM_Custom_Form_CustomData
::preProcess($this, NULL, NULL, 1, 'Group', $this->_id
);
162 * Set default values for the form.
166 public function setDefaultValues() {
168 if (isset($this->_id
)) {
169 $defaults = $this->_groupValues
;
170 if (!empty($defaults['group_type'])) {
171 $types = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
172 substr($defaults['group_type'], 1, -1)
174 $defaults['group_type'] = array();
175 foreach ($types as $type) {
176 $defaults['group_type'][$type] = 1;
180 if (CRM_Core_Permission
::check('administer Multiple Organizations') && CRM_Core_Permission
::isMultisiteEnabled()) {
181 CRM_Contact_BAO_GroupOrganization
::retrieve($this->_id
, $defaults);
185 $defaults['is_active'] = 1;
188 if (!((CRM_Core_Permission
::check('access CiviMail')) ||
189 (CRM_Mailing_Info
::workflowEnabled() &&
190 CRM_Core_Permission
::check('create mailings')
194 $groupTypes = CRM_Core_OptionGroup
::values('group_type', TRUE);
195 if ($defaults['group_type'][$groupTypes['Mailing List']] == 1) {
196 $this->assign('freezeMailignList', $groupTypes['Mailing List']);
199 $this->assign('hideMailignList', $groupTypes['Mailing List']);
203 if (empty($defaults['parents'])) {
204 $defaults['parents'] = CRM_Core_BAO_Domain
::getGroupId();
207 // custom data set defaults
208 $defaults +
= CRM_Custom_Form_CustomData
::setDefaultValues($this);
213 * Build the form object.
215 public function buildQuickForm() {
216 if ($this->_action
== CRM_Core_Action
::DELETE
) {
217 $this->addButtons(array(
220 'name' => ts('Delete Group'),
225 'name' => ts('Cancel'),
232 // We want the "new group" form to redirect the user
233 if ($this->_action
== CRM_Core_Action
::ADD
) {
234 $this->preventAjaxSubmit();
237 $this->applyFilter('__ALL__', 'trim');
238 $this->add('text', 'title', ts('Name') . ' ',
239 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Group', 'title'), TRUE
242 $this->add('textarea', 'description', ts('Description') . ' ',
243 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Group', 'description')
246 $groupTypes = CRM_Core_OptionGroup
::values('group_type', TRUE);
248 if (isset($this->_id
) && !empty($this->_groupValues
['saved_search_id'])) {
249 unset($groupTypes['Access Control']);
252 if (!empty($groupTypes)) {
253 $this->addCheckBox('group_type',
256 NULL, NULL, NULL, NULL, ' '
260 $this->add('select', 'visibility', ts('Visibility'), CRM_Core_SelectValues
::groupVisibility(), TRUE);
263 $parentGroups = self
::buildParentGroups($this);
264 self
::buildGroupOrganizations($this);
266 // is_reserved property CRM-9936
267 $this->addElement('checkbox', 'is_reserved', ts('Reserved Group?'));
268 if (!CRM_Core_Permission
::check('administer reserved groups')) {
269 $this->freeze('is_reserved');
271 $this->addElement('checkbox', 'is_active', ts('Is active?'));
274 CRM_Custom_Form_CustomData
::buildQuickForm($this);
276 $this->addButtons(array(
279 'name' => ($this->_action
== CRM_Core_Action
::ADD
) ?
ts('Continue') : ts('Save'),
284 'name' => ts('Cancel'),
289 $doParentCheck = FALSE;
290 if (CRM_Core_Permission
::isMultisiteEnabled()) {
291 $doParentCheck = ($this->_id
&& CRM_Core_BAO_Domain
::isDomainGroup($this->_id
)) ?
FALSE : TRUE;
296 'parentGroups' => $parentGroups,
297 'doParentCheck' => $doParentCheck,
299 $this->addFormRule(array('CRM_Group_Form_Edit', 'formRule'), $options);
303 * Global validation rules for the form.
305 * @param array $fields
306 * Posted values of the form.
307 * @param array $fileParams
308 * @param array $options
311 * list of errors to be posted back to the form
313 public static function formRule($fields, $fileParams, $options) {
316 $doParentCheck = $options['doParentCheck'];
317 $self = &$options['selfObj'];
319 if ($doParentCheck) {
320 $parentGroups = $options['parentGroups'];
323 foreach ($fields as $key => $val) {
324 if (substr($key, 0, 20) == 'remove_parent_group_') {
330 if (!empty($fields['parents'])) {
334 if ((count($parentGroups) >= 1) && (($grpRemove - $grpAdd) >= count($parentGroups))) {
335 $errors['parents'] = ts('Make sure at least one parent group is set.');
339 // do check for both name and title uniqueness
340 if (!empty($fields['title'])) {
341 $title = trim($fields['title']);
347 $params = array(1 => array($title, 'String'));
350 $query .= "AND id <> %2";
351 $params[2] = array($self->_id
, 'Integer');
354 $grpCnt = CRM_Core_DAO
::singleValueQuery($query, $params);
356 $errors['title'] = ts('Group \'%1\' already exists.', array(1 => $fields['title']));
360 return empty($errors) ?
TRUE : $errors;
364 * Process the form when submitted.
366 public function postProcess() {
367 CRM_Utils_System
::flushCache('CRM_Core_DAO_Group');
369 $updateNestingCache = FALSE;
370 if ($this->_action
& CRM_Core_Action
::DELETE
) {
371 CRM_Contact_BAO_Group
::discard($this->_id
);
372 CRM_Core_Session
::setStatus(ts("The Group '%1' has been deleted.", array(1 => $this->_title
)), ts('Group Deleted'), 'success');
373 $updateNestingCache = TRUE;
376 // store the submitted values in an array
377 $params = $this->controller
->exportValues($this->_name
);
378 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
379 $params['id'] = $this->_id
;
382 if ($this->_action
& CRM_Core_Action
::UPDATE
&& isset($this->_groupOrganizationID
)) {
383 $params['group_organization'] = $this->_groupOrganizationID
;
386 // CRM-21431 If all group_type are unchecked, the change will not be saved otherwise.
387 if (!isset($params['group_type'])) {
388 $params['group_type'] = array();
391 $params['is_reserved'] = CRM_Utils_Array
::value('is_reserved', $params, FALSE);
392 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
393 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
398 $group = CRM_Contact_BAO_Group
::create($params);
400 //Remove any parent groups requested to be removed
401 if (!empty($this->_groupValues
['parents'])) {
402 $parentGroupIds = explode(',', $this->_groupValues
['parents']);
403 foreach ($parentGroupIds as $parentGroupId) {
404 if (isset($params["remove_parent_group_$parentGroupId"])) {
405 CRM_Contact_BAO_GroupNesting
::remove($parentGroupId, $group->id
);
406 $updateNestingCache = TRUE;
411 CRM_Core_Session
::setStatus(ts('The Group \'%1\' has been saved.', array(1 => $group->title
)), ts('Group Saved'), 'success');
413 // Add context to the session, in case we are adding members to the group
414 if ($this->_action
& CRM_Core_Action
::ADD
) {
415 $this->set('context', 'amtg');
416 $this->set('amtgID', $group->id
);
418 $session = CRM_Core_Session
::singleton();
419 $session->pushUserContext(CRM_Utils_System
::url('civicrm/group/search', 'reset=1&force=1&context=smog&gid=' . $group->id
));
423 // update the nesting cache
424 if ($updateNestingCache) {
425 CRM_Contact_BAO_GroupNestingCache
::update();
430 * Build parent groups form elements.
432 * @param CRM_Core_Form $form
437 public static function buildParentGroups(&$form) {
438 $groupNames = CRM_Core_PseudoConstant
::group();
439 $parentGroups = $parentGroupElements = array();
440 if (isset($form->_id
) && !empty($form->_groupValues
['parents'])) {
441 $parentGroupIds = explode(',', $form->_groupValues
['parents']);
442 foreach ($parentGroupIds as $parentGroupId) {
443 $parentGroups[$parentGroupId] = $groupNames[$parentGroupId];
444 if (array_key_exists($parentGroupId, $groupNames)) {
445 $parentGroupElements[$parentGroupId] = $groupNames[$parentGroupId];
446 $form->addElement('checkbox', "remove_parent_group_$parentGroupId",
447 $groupNames[$parentGroupId]
452 $form->assign_by_ref('parent_groups', $parentGroupElements);
454 if (isset($form->_id
)) {
455 $potentialParentGroupIds = CRM_Contact_BAO_GroupNestingCache
::getPotentialCandidates($form->_id
, $groupNames);
458 $potentialParentGroupIds = array_keys($groupNames);
461 $parentGroupSelectValues = array('' => '- ' . ts('select group') . ' -');
462 foreach ($potentialParentGroupIds as $potentialParentGroupId) {
463 if (array_key_exists($potentialParentGroupId, $groupNames)) {
464 $parentGroupSelectValues[$potentialParentGroupId] = $groupNames[$potentialParentGroupId];
468 if (count($parentGroupSelectValues) > 1) {
469 if (CRM_Core_Permission
::isMultisiteEnabled()) {
470 $required = !isset($form->_id
) ||
($form->_id
&& CRM_Core_BAO_Domain
::isDomainGroup($form->_id
)) ?
FALSE : empty($parentGroups);
475 $form->add('select', 'parents', ts('Add Parent'), $parentGroupSelectValues, $required, array('class' => 'crm-select2'));
478 return $parentGroups;
482 * Add the group organization checkbox to the form.
484 * Note this was traditionally a multisite thing - there is no particular reason why it is not available
485 * as a general field - it's historical use-case driven.
487 * @param CRM_Core_Form $form
489 public static function buildGroupOrganizations(&$form) {
490 if (CRM_Core_Permission
::check('administer Multiple Organizations') && CRM_Core_Permission
::isMultisiteEnabled()) {
491 //group organization Element
492 $props = array('api' => array('params' => array('contact_type' => 'Organization')));
493 $form->addEntityRef('organization_id', ts('Organization'), $props);