CRM/Contact/Form/Task/RemoveFromGroup.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33
  34 /**
  35  * This class provides the functionality to delete a group of
  36  * contacts. This class provides functionality for the actual
  37  * addition of contacts to groups.
  38  */
  39 class CRM_Contact_Form_Task_RemoveFromGroup extends CRM_Contact_Form_Task {
  40
  41   /**
  42    * Build the form object.
  43    */
  44   public function buildQuickForm() {
  45     // add select for groups
  46     $group = array('' => ts('- select group -')) + CRM_Core_PseudoConstant::nestedGroup();
  47     $groupElement = $this->add('select', 'group_id', ts('Select Group'), $group, TRUE, array('class' => 'crm-select2 huge'));
  48
  49     CRM_Utils_System::setTitle(ts('Remove Contacts from Group'));
  50     $this->addDefaultButtons(ts('Remove from Group'));
  51   }
  52
  53   /**
  54    * Set the default form values.
  55    *
  56    *
  57    * @return array
  58    *   the default array reference
  59    */
  60   public function setDefaultValues() {
  61     $defaults = array();
  62
  63     if ($this->get('context') === 'smog') {
  64       $defaults['group_id'] = $this->get('gid');
  65     }
  66     return $defaults;
  67   }
  68
  69   /**
  70    * Process the form after the input has been submitted and validated.
  71    */
  72   public function postProcess() {
  73     $groupId = $this->controller->exportValue('RemoveFromGroup', 'group_id');
  74     $group = CRM_Core_PseudoConstant::group();
  75
  76     list($total, $removed, $notRemoved) = CRM_Contact_BAO_GroupContact::removeContactsFromGroup($this->_contactIds, $groupId);
  77
  78     $status = array(
  79       ts("%count contact removed from '%2'", array(
  80         'count' => $removed,
  81         'plural' => "%count contacts removed from '%2'",
  82         2 => $group[$groupId],
  83       )),
  84     );
  85     if ($notRemoved) {
  86       $status[] = ts('1 contact was already not in this group', array(
  87           'count' => $notRemoved,
  88           'plural' => '%count contacts were already not in this group',
  89         ));
  90     }
  91     $status = '<ul><li>' . implode('</li><li>', $status) . '</li></ul>';
  92     CRM_Core_Session::setStatus($status, ts("Removed Contact From Group", array(
  93           'plural' => "Removed Contacts From Group",
  94           'count' => $removed,
  95         )), 'success', array('expires' => 0));
  96   }
  97
  98 }