CRM/Contact/Form/Task/AddToGroup.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 group contacts.
  36  *
  37  * This class provides functionality for the actual
  38  * addition of contacts to groups.
  39  */
  40 class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task {
  41
  42   /**
  43    * The context that we are working on
  44    *
  45    * @var string
  46    */
  47   protected $_context;
  48
  49   /**
  50    * The groupId retrieved from the GET vars
  51    *
  52    * @var int
  53    */
  54   protected $_id;
  55
  56   /**
  57    * The title of the group
  58    *
  59    * @var string
  60    */
  61   protected $_title;
  62
  63   /**
  64    * Build all the data structures needed to build the form.
  65    */
  66   public function preProcess() {
  67     // initialize the task and row fields
  68     parent::preProcess();
  69
  70     $this->_context = $this->get('context');
  71     $this->_id = $this->get('amtgID');
  72   }
  73
  74   /**
  75    * Build the form object.
  76    */
  77   public function buildQuickForm() {
  78
  79     //create radio buttons to select existing group or add a new group
  80     $options = [ts('Add Contact To Existing Group'), ts('Create New Group')];
  81
  82     if (!$this->_id) {
  83       $this->addRadio('group_option', ts('Group Options'), $options, ['onclick' => "return showElements();"]);
  84
  85       $this->add('text', 'title', ts('Group Name:') . ' ',
  86         CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Group', 'title')
  87       );
  88       $this->addRule('title', ts('Name already exists in Database.'),
  89         'objectExists', ['CRM_Contact_DAO_Group', $this->_id, 'title']
  90       );
  91
  92       $this->add('textarea', 'description', ts('Description:') . ' ',
  93         CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Group', 'description')
  94       );
  95
  96       $groupTypes = CRM_Core_OptionGroup::values('group_type', TRUE);
  97       if (!CRM_Core_Permission::access('CiviMail')) {
  98         $isWorkFlowEnabled = CRM_Mailing_Info::workflowEnabled();
  99         if ($isWorkFlowEnabled &&
 100           !CRM_Core_Permission::check('create mailings') &&
 101           !CRM_Core_Permission::check('schedule mailings') &&
 102           !CRM_Core_Permission::check('approve mailings')
 103         ) {
 104           unset($groupTypes['Mailing List']);
 105         }
 106       }
 107
 108       if (!empty($groupTypes)) {
 109         $this->addCheckBox('group_type',
 110           ts('Group Type'),
 111           $groupTypes,
 112           NULL, NULL, NULL, NULL, '&nbsp;&nbsp;&nbsp;'
 113         );
 114       }
 115     }
 116
 117     // add select for groups
 118     $group = ['' => ts('- select group -')] + CRM_Core_PseudoConstant::nestedGroup();
 119
 120     $groupElement = $this->add('select', 'group_id', ts('Select Group'), $group, FALSE, ['class' => 'crm-select2 huge']);
 121
 122     $this->_title = $group[$this->_id];
 123
 124     if ($this->_context === 'amtg') {
 125       $groupElement->freeze();
 126
 127       // also set the group title
 128       $groupValues = ['id' => $this->_id, 'title' => $this->_title];
 129       $this->assign_by_ref('group', $groupValues);
 130     }
 131
 132     // Set dynamic page title for 'Add Members Group (confirm)'
 133     if ($this->_id) {
 134       CRM_Utils_System::setTitle(ts('Add Contacts: %1', [1 => $this->_title]));
 135     }
 136     else {
 137       CRM_Utils_System::setTitle(ts('Add Contacts to A Group'));
 138     }
 139
 140     $this->addDefaultButtons(ts('Add to Group'));
 141   }
 142
 143   /**
 144    * Set the default form values.
 145    *
 146    *
 147    * @return array
 148    *   the default array reference
 149    */
 150   public function setDefaultValues() {
 151     $defaults = [];
 152
 153     if ($this->_context === 'amtg') {
 154       $defaults['group_id'] = $this->_id;
 155     }
 156
 157     $defaults['group_option'] = 0;
 158     return $defaults;
 159   }
 160
 161   /**
 162    * Add local and global form rules.
 163    */
 164   public function addRules() {
 165     $this->addFormRule(['CRM_Contact_Form_task_AddToGroup', 'formRule']);
 166   }
 167
 168   /**
 169    * Global validation rules for the form.
 170    *
 171    * @param array $params
 172    *
 173    * @return array
 174    *   list of errors to be posted back to the form
 175    */
 176   public static function formRule($params) {
 177     $errors = [];
 178
 179     if (!empty($params['group_option']) && empty($params['title'])) {
 180       $errors['title'] = "Group Name is a required field";
 181     }
 182     elseif (empty($params['group_option']) && empty($params['group_id'])) {
 183       $errors['group_id'] = "Select Group is a required field.";
 184     }
 185
 186     return empty($errors) ? TRUE : $errors;
 187   }
 188
 189   /**
 190    * Process the form after the input has been submitted and validated.
 191    */
 192   public function postProcess() {
 193     $params = $this->controller->exportValues();
 194     $groupOption = CRM_Utils_Array::value('group_option', $params, NULL);
 195     if ($groupOption) {
 196       $groupParams = [];
 197       $groupParams['title'] = $params['title'];
 198       $groupParams['description'] = $params['description'];
 199       $groupParams['visibility'] = "User and User Admin Only";
 200       if (array_key_exists('group_type', $params) && is_array($params['group_type'])) {
 201         $groupParams['group_type'] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
 202             array_keys($params['group_type'])
 203           ) . CRM_Core_DAO::VALUE_SEPARATOR;
 204       }
 205       else {
 206         $groupParams['group_type'] = '';
 207       }
 208       $groupParams['is_active'] = 1;
 209
 210       $createdGroup = CRM_Contact_BAO_Group::create($groupParams);
 211       $groupID = $createdGroup->id;
 212       $groupName = $groupParams['title'];
 213     }
 214     else {
 215       $groupID = $params['group_id'];
 216       $group = CRM_Core_PseudoConstant::group();
 217       $groupName = $group[$groupID];
 218     }
 219
 220     list($total, $added, $notAdded) = CRM_Contact_BAO_GroupContact::addContactsToGroup($this->_contactIds, $groupID);
 221
 222     $status = [
 223       ts('%count contact added to group', [
 224           'count' => $added,
 225           'plural' => '%count contacts added to group',
 226       ]),
 227     ];
 228     if ($notAdded) {
 229       $status[] = ts('%count contact was already in group', [
 230           'count' => $notAdded,
 231           'plural' => '%count contacts were already in group',
 232         ]);
 233     }
 234     $status = '<ul><li>' . implode('</li><li>', $status) . '</li></ul>';
 235     CRM_Core_Session::setStatus($status, ts('Added Contact to %1', [
 236           1 => $groupName,
 237           'count' => $added,
 238           'plural' => 'Added Contacts to %1',
 239         ]), 'success', ['expires' => 0]);
 240
 241     if ($this->_context === 'amtg') {
 242       CRM_Core_Session::singleton()
 243         ->pushUserContext(CRM_Utils_System::url('civicrm/group/search', "reset=1&force=1&context=smog&gid=$groupID"));
 244     }
 245   }
 246
 247 }