CRM/Contact/Form/Task/RemoveFromGroup.php

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