CRM/Contact/Page/View/GroupContact.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 class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page {
  34
  35   /**
  36    * Called when action is browse.
  37    */
  38   public function browse() {
  39
  40     $count = CRM_Contact_BAO_GroupContact::getContactGroup($this->_contactId, NULL, NULL, TRUE, FALSE, FALSE, TRUE, NULL, TRUE);
  41
  42     $in = CRM_Contact_BAO_GroupContact::getContactGroup($this->_contactId, 'Added', NULL, FALSE, FALSE, FALSE, TRUE, NULL, TRUE);
  43     $pending = CRM_Contact_BAO_GroupContact::getContactGroup($this->_contactId, 'Pending', NULL, FALSE, FALSE, FALSE, TRUE, NULL, TRUE);
  44     $out = CRM_Contact_BAO_GroupContact::getContactGroup($this->_contactId, 'Removed', NULL, FALSE, FALSE, FALSE, TRUE, NULL, TRUE);
  45
  46     // keep track of all 'added' contact groups so we can remove them from the smart group
  47     // section
  48     $staticGroups = [];
  49     if (!empty($in)) {
  50       foreach ($in as $group) {
  51         $staticGroups[$group['group_id']] = 1;
  52       }
  53     }
  54
  55     $this->assign('groupCount', $count);
  56     $this->assign_by_ref('groupIn', $in);
  57     $this->assign_by_ref('groupPending', $pending);
  58     $this->assign_by_ref('groupOut', $out);
  59
  60     // get the info on contact smart groups
  61     $contactSmartGroupSettings = Civi::settings()->get('contact_smart_group_display');
  62     $this->assign('contactSmartGroupSettings', $contactSmartGroupSettings);
  63
  64     $this->ajaxResponse['tabCount'] = count($in);
  65   }
  66
  67   /**
  68    * called when action is update.
  69    *
  70    * @param int $groupId
  71    *
  72    */
  73   public function edit($groupId = NULL) {
  74     $controller = new CRM_Core_Controller_Simple(
  75       'CRM_Contact_Form_GroupContact',
  76       ts('Contact\'s Groups'),
  77       $this->_action
  78     );
  79     $controller->setEmbedded(TRUE);
  80
  81     // set the userContext stack
  82     $session = CRM_Core_Session::singleton();
  83
  84     $session->pushUserContext(
  85       CRM_Utils_System::url(
  86         'civicrm/contact/view',
  87         "action=browse&selectedChild=group&cid={$this->_contactId}"
  88       ),
  89       FALSE
  90     );
  91     $controller->reset();
  92
  93     $controller->set('contactId', $this->_contactId);
  94     $controller->set('groupId', $groupId);
  95
  96     $controller->process();
  97     $controller->run();
  98   }
  99
 100   public function preProcess() {
 101     $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
 102     $this->assign('contactId', $this->_contactId);
 103
 104     // check logged in url permission
 105     CRM_Contact_Page_View::checkUserPermission($this);
 106
 107     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
 108     $this->assign('action', $this->_action);
 109   }
 110
 111   /**
 112    * the main function that is called
 113    * when the page loads, it decides the which action has
 114    * to be taken for the page.
 115    *
 116    * @return null
 117    */
 118   public function run() {
 119     $this->preProcess();
 120
 121     $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactId);
 122     $this->assign('displayName', $displayName);
 123
 124     if ($this->_action == CRM_Core_Action::DELETE) {
 125       $groupContactId = CRM_Utils_Request::retrieve('gcid', 'Positive', CRM_Core_DAO::$_nullObject, TRUE);
 126       $status = CRM_Utils_Request::retrieve('st', 'String', CRM_Core_DAO::$_nullObject, TRUE);
 127       if (is_numeric($groupContactId) && $status) {
 128         $this->del($groupContactId, $status, $this->_contactId);
 129       }
 130       $session = CRM_Core_Session::singleton();
 131       CRM_Utils_System::redirect($session->popUserContext());
 132     }
 133
 134     $this->edit(NULL, CRM_Core_Action::ADD);
 135     $this->browse();
 136     return parent::run();
 137   }
 138
 139   /**
 140    * Remove/ rejoin the group
 141    *
 142    * @param int $groupContactId
 143    *   Id of crm_group_contact.
 144    * @param string $status
 145    *   This is the status that should be updated.
 146    *
 147    * $access public
 148    * @param int $contactID
 149    *
 150    * @return bool
 151    */
 152   public static function del($groupContactId, $status, $contactID) {
 153     $groupId = CRM_Contact_BAO_GroupContact::getGroupId($groupContactId);
 154
 155     switch ($status) {
 156       case 'i':
 157         $groupStatus = 'Added';
 158         break;
 159
 160       case 'p':
 161         $groupStatus = 'Pending';
 162         break;
 163
 164       case 'o':
 165         $groupStatus = 'Removed';
 166         break;
 167
 168       case 'd':
 169         $groupStatus = 'Deleted';
 170         break;
 171     }
 172
 173     $groupNum = CRM_Contact_BAO_GroupContact::getContactGroup($contactID, 'Added', NULL, TRUE, TRUE);
 174     if ($groupNum == 1 && $groupStatus == 'Removed' && Civi::settings()->get('is_enabled')) {
 175       CRM_Core_Session::setStatus(ts('Please ensure at least one contact group association is maintained.'), ts('Could Not Remove'));
 176       return FALSE;
 177     }
 178
 179     $ids = [$contactID];
 180     $method = 'Admin';
 181
 182     $session = CRM_Core_Session::singleton();
 183     $userID = $session->get('userID');
 184
 185     if ($userID == $contactID) {
 186       $method = 'Web';
 187     }
 188
 189     CRM_Contact_BAO_GroupContact::removeContactsFromGroup($ids, $groupId, $method, $groupStatus);
 190   }
 191
 192 }