crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/CRM/Event/Form/Task/AddToGroup.php

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