CRM/Contact/Form/GroupContact.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 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   public 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    * Build the form object
  64    *
  65    * @return void
  66    */
  67   public function buildQuickForm() {
  68     // get the list of all the groups
  69     if ($this->_context == 'user') {
  70       $onlyPublicGroups = CRM_Utils_Request::retrieve('onlyPublicGroups', 'Boolean', $this, FALSE);
  71       $allGroups = CRM_Core_PseudoConstant::staticGroup($onlyPublicGroups);
  72     }
  73     else {
  74       $allGroups = CRM_Core_PseudoConstant::group();
  75     }
  76
  77     // Arrange groups into hierarchical listing (child groups follow their parents and have indentation spacing in title)
  78     $groupHierarchy = CRM_Contact_BAO_Group::getGroupsHierarchy($allGroups, NULL, '&nbsp;&nbsp;', TRUE);
  79
  80     // get the list of groups contact is currently in ("Added") or unsubscribed ("Removed").
  81     $currentGroups = CRM_Contact_BAO_GroupContact::getGroupList($this->_contactId);
  82
  83     // Remove current groups from drowdown options ($groupSelect)
  84     if (is_array($currentGroups)) {
  85       // Compare array keys, since the array values (group title) in $groupList may have extra spaces for indenting child groups
  86       $groupSelect = array_diff_key($groupHierarchy, $currentGroups);
  87     }
  88     else {
  89       $groupSelect = $groupHierarchy;
  90     }
  91
  92     $groupSelect = array( '' => ts('- select group -')) + $groupSelect;
  93
  94     if (count($groupSelect) > 1) {
  95       $session = CRM_Core_Session::singleton();
  96       // user dashboard
  97       if (strstr($session->readUserContext(), 'user')) {
  98         $msg = ts('Join a Group');
  99       }
 100       else {
 101         $msg = ts('Add to a group');
 102       }
 103
 104       $this->add('select', 'group_id', '', $groupSelect, TRUE, array('class' => 'crm-select2 crm-action-menu action-icon-plus', 'placeholder' => $msg));
 105
 106       $this->addButtons(array(
 107           array(
 108             'type' => 'next',
 109             'name' => ts('Add'),
 110             'isDefault' => TRUE,
 111           ),
 112         )
 113       );
 114     }
 115   }
 116
 117   /**
 118    *
 119    * @return void
 120    */
 121   public function postProcess() {
 122     $contactID = array($this->_contactId);
 123     $groupId   = $this->controller->exportValue('GroupContact', 'group_id');
 124     $method    = ($this->_context == 'user') ? 'Web' : 'Admin';
 125
 126     $session = CRM_Core_Session::singleton();
 127     $userID = $session->get('userID');
 128
 129     if ($userID == $this->_contactId) {
 130       $method = 'Web';
 131     }
 132     $groupContact = CRM_Contact_BAO_GroupContact::addContactsToGroup($contactID, $groupId, $method);
 133
 134     if ($groupContact && $this->_context != 'user') {
 135       $groups = CRM_Core_PseudoConstant::group();
 136       CRM_Core_Session::setStatus(ts("Contact has been added to '%1'.", array(1 => $groups[$groupId])), ts('Added to Group'), 'success');
 137     }
 138   }
 139 }