CRM/Contact/Form/GroupContact.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for groupContact
  38  *
  39  */
  40 class CRM_Contact_Form_GroupContact extends CRM_Core_Form {
  41
  42   /**
  43    * The groupContact id, used when editing the groupContact
  44    *
  45    * @var int
  46    */
  47   protected $_groupContactId;
  48
  49   /**
  50    * The contact id, used when add/edit groupContact
  51    *
  52    * @var int
  53    */
  54   protected $_contactId;
  55
  56   function preProcess() {
  57     $this->_contactId = $this->get('contactId');
  58     $this->_groupContactId = $this->get('groupContactId');
  59     $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
  60   }
  61
  62   /**
  63    * Function to build the form
  64    *
  65    * @return void
  66    * @access public
  67    */
  68   public function buildQuickForm() {
  69     // get the list of all the groups
  70     if ($this->_context == 'user') {
  71       $onlyPublicGroups = CRM_Utils_Request::retrieve('onlyPublicGroups', 'Boolean', $this, FALSE);
  72       $allGroups = CRM_Core_PseudoConstant::staticGroup($onlyPublicGroups);
  73     }
  74     else {
  75       $allGroups = CRM_Core_PseudoConstant::group();
  76     }
  77
  78     // Arrange groups into hierarchical listing (child groups follow their parents and have indentation spacing in title)
  79     $groupHierarchy = CRM_Contact_BAO_Group::getGroupsHierarchy($allGroups, NULL, '&nbsp;&nbsp;', TRUE);
  80
  81     // get the list of groups contact is currently in ("Added") or unsubscribed ("Removed").
  82     $currentGroups = CRM_Contact_BAO_GroupContact::getGroupList($this->_contactId);
  83
  84     // Remove current groups from drowdown options ($groupSelect)
  85     if (is_array($currentGroups)) {
  86       // Compare array keys, since the array values (group title) in $groupList may have extra spaces for indenting child groups
  87       $groupSelect = array_diff_key($groupHierarchy, $currentGroups);
  88     }
  89     else {
  90       $groupSelect = $groupHierarchy;
  91     }
  92
  93     $groupSelect = array( '' => ts('- select group -')) + $groupSelect;
  94
  95     if (count($groupSelect) > 1) {
  96       $session = CRM_Core_Session::singleton();
  97       // user dashboard
  98       if (strstr($session->readUserContext(), 'user')) {
  99         $msg = ts('Join a Group');
 100       }
 101       else {
 102         $msg = ts('Add to a group');
 103       }
 104
 105       $this->add('select', 'group_id', $msg, $groupSelect, TRUE, array('class' => 'crm-select2'));
 106
 107       $this->addButtons(array(
 108           array(
 109             'type' => 'next',
 110             'name' => ts('Add'),
 111             'isDefault' => TRUE,
 112           ),
 113         )
 114       );
 115     }
 116   }
 117
 118   /**
 119    *
 120    * @access public
 121    *
 122    * @return void
 123    */
 124   public function postProcess() {
 125     $contactID = array($this->_contactId);
 126     $groupId   = $this->controller->exportValue('GroupContact', 'group_id');
 127     $method    = ($this->_context == 'user') ? 'Web' : 'Admin';
 128
 129     $session = CRM_Core_Session::singleton();
 130     $userID = $session->get('userID');
 131
 132     if ($userID == $this->_contactId) {
 133       $method = 'Web';
 134     }
 135     $groupContact = CRM_Contact_BAO_GroupContact::addContactsToGroup($contactID, $groupId, $method);
 136
 137     if ($groupContact && $this->_context != 'user') {
 138       $groups = CRM_Core_PseudoConstant::group();
 139       CRM_Core_Session::setStatus(ts("Contact has been added to '%1'.", array(1 => $groups[$groupId])), ts('Added to Group'), 'success');
 140     }
 141   }
 142   //end of function
 143 }
 144