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