| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.5 | |
| 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 | class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { |
| 36 | |
| 37 | /** |
| 38 | * The action links that we need to display for the browse screen |
| 39 | * |
| 40 | * @var array |
| 41 | * @static |
| 42 | */ |
| 43 | static $_links = NULL; |
| 44 | |
| 45 | /** |
| 46 | * casid set if called from case context |
| 47 | * |
| 48 | * @var int |
| 49 | */ |
| 50 | public $_caseId = NULL; |
| 51 | |
| 52 | public $_permission = NULL; |
| 53 | public $_contactId = NULL; |
| 54 | |
| 55 | /** |
| 56 | * View details of a relationship |
| 57 | * |
| 58 | * @return void |
| 59 | * |
| 60 | * @access public |
| 61 | */ |
| 62 | function view() { |
| 63 | $viewRelationship = CRM_Contact_BAO_Relationship::getRelationship($this->_contactId, NULL, NULL, NULL, $this->_id); |
| 64 | //To check whether selected contact is a contact_id_a in |
| 65 | //relationship type 'a_b' in relationship table, if yes then |
| 66 | //revert the permissionship text in template |
| 67 | $relationship = new CRM_Contact_DAO_Relationship(); |
| 68 | $relationship->id = $viewRelationship[$this->_id]['id']; |
| 69 | |
| 70 | if ($relationship->find(TRUE)) { |
| 71 | if (($viewRelationship[$this->_id]['rtype'] == 'a_b') && ($this->_contactId == $relationship->contact_id_a)) { |
| 72 | $this->assign("is_contact_id_a", TRUE); |
| 73 | } |
| 74 | } |
| 75 | $relType = $viewRelationship[$this->_id]['civicrm_relationship_type_id']; |
| 76 | $this->assign('viewRelationship', $viewRelationship); |
| 77 | |
| 78 | $employerId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId, 'employer_id'); |
| 79 | $this->assign('isCurrentEmployer', FALSE); |
| 80 | |
| 81 | $relTypes = CRM_Utils_Array::index(array('name_a_b'), CRM_Core_PseudoConstant::relationshipType('name')); |
| 82 | |
| 83 | if ($viewRelationship[$this->_id]['employer_id'] == $this->_contactId) { |
| 84 | $this->assign('isCurrentEmployer', TRUE); |
| 85 | } |
| 86 | elseif ($relType == $relTypes['Employee of']['id'] && |
| 87 | ($viewRelationship[$this->_id]['cid'] == $employerId) |
| 88 | ) { |
| 89 | // make sure we are viewing employee of relationship |
| 90 | $this->assign('isCurrentEmployer', TRUE); |
| 91 | } |
| 92 | |
| 93 | $viewNote = CRM_Core_BAO_Note::getNote($this->_id); |
| 94 | $this->assign('viewNote', $viewNote); |
| 95 | |
| 96 | $groupTree = CRM_Core_BAO_CustomGroup::getTree('Relationship', $this, $this->_id, 0, $relType); |
| 97 | CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree); |
| 98 | |
| 99 | $rType = CRM_Utils_Array::value('rtype', $viewRelationship[$this->_id]); |
| 100 | // add viewed contribution to recent items list |
| 101 | $url = CRM_Utils_System::url('civicrm/contact/view/rel', |
| 102 | "action=view&reset=1&id={$viewRelationship[$this->_id]['id']}&cid={$this->_contactId}&context=home" |
| 103 | ); |
| 104 | |
| 105 | |
| 106 | $session = CRM_Core_Session::singleton(); |
| 107 | $recentOther = array(); |
| 108 | |
| 109 | if (($session->get('userID') == $this->_contactId) || |
| 110 | CRM_Contact_BAO_Contact_Permission::allow($this->_contactId, CRM_Core_Permission::EDIT) |
| 111 | ) { |
| 112 | $recentOther = array( |
| 113 | 'editUrl' => CRM_Utils_System::url('civicrm/contact/view/rel', |
| 114 | "action=update&reset=1&id={$viewRelationship[$this->_id]['id']}&cid={$this->_contactId}&rtype={$rType}&context=home" |
| 115 | ), |
| 116 | 'deleteUrl' => CRM_Utils_System::url('civicrm/contact/view/rel', |
| 117 | "action=delete&reset=1&id={$viewRelationship[$this->_id]['id']}&cid={$this->_contactId}&rtype={$rType}&context=home" |
| 118 | ), |
| 119 | ); |
| 120 | } |
| 121 | |
| 122 | $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactId); |
| 123 | $this->assign('displayName', $displayName); |
| 124 | CRM_Utils_System::setTitle(ts('View Relationship for') . ' ' . $displayName); |
| 125 | |
| 126 | $title = $displayName . ' (' . $viewRelationship[$this->_id]['relation'] . ' ' . CRM_Contact_BAO_Contact::displayName($viewRelationship[$this->_id]['cid']) . ')'; |
| 127 | |
| 128 | // add the recently viewed Relationship |
| 129 | CRM_Utils_Recent::add($title, |
| 130 | $url, |
| 131 | $viewRelationship[$this->_id]['id'], |
| 132 | 'Relationship', |
| 133 | $this->_contactId, |
| 134 | NULL, |
| 135 | $recentOther |
| 136 | ); |
| 137 | } |
| 138 | |
| 139 | /** |
| 140 | * This function is called when action is browse |
| 141 | * |
| 142 | * return null |
| 143 | * @access public |
| 144 | */ |
| 145 | function browse() { |
| 146 | // do nothing :) we are using datatable for rendering relationship selectors |
| 147 | } |
| 148 | |
| 149 | /** |
| 150 | * This function is called when action is update or new |
| 151 | * |
| 152 | * return null |
| 153 | * @access public |
| 154 | */ |
| 155 | function edit() { |
| 156 | $controller = new CRM_Core_Controller_Simple('CRM_Contact_Form_Relationship', ts('Contact Relationships'), $this->_action); |
| 157 | $controller->setEmbedded(TRUE); |
| 158 | |
| 159 | // set the userContext stack |
| 160 | $session = CRM_Core_Session::singleton(); |
| 161 | |
| 162 | // if this is called from case view, we need to redirect back to same page |
| 163 | if ($this->_caseId) { |
| 164 | $url = CRM_Utils_System::url('civicrm/contact/view/case', "action=view&reset=1&cid={$this->_contactId}&id={$this->_caseId}"); |
| 165 | } |
| 166 | else { |
| 167 | $url = CRM_Utils_System::url('civicrm/contact/view', "action=browse&selectedChild=rel&reset=1&cid={$this->_contactId}"); |
| 168 | } |
| 169 | |
| 170 | $session->pushUserContext($url); |
| 171 | |
| 172 | if (CRM_Utils_Request::retrieve('confirmed', 'Boolean', |
| 173 | CRM_Core_DAO::$_nullObject |
| 174 | )) { |
| 175 | if ($this->_caseId) { |
| 176 | //create an activity for case role removal.CRM-4480 |
| 177 | CRM_Case_BAO_Case::createCaseRoleActivity($this->_caseId, $this->_id); |
| 178 | CRM_Core_Session::setStatus(ts('Case Role has been deleted successfully.'), ts('Record Deleted'), 'success'); |
| 179 | } |
| 180 | |
| 181 | // delete relationship |
| 182 | CRM_Contact_BAO_Relationship::del($this->_id); |
| 183 | |
| 184 | CRM_Utils_System::redirect($url); |
| 185 | } |
| 186 | |
| 187 | $controller->set('contactId', $this->_contactId); |
| 188 | $controller->set('id', $this->_id); |
| 189 | $controller->process(); |
| 190 | $controller->run(); |
| 191 | } |
| 192 | |
| 193 | function preProcess() { |
| 194 | $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this); |
| 195 | $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE); |
| 196 | $this->assign('contactId', $this->_contactId); |
| 197 | |
| 198 | // check logged in url permission |
| 199 | CRM_Contact_Page_View::checkUserPermission($this); |
| 200 | |
| 201 | // set page title |
| 202 | CRM_Contact_Page_View::setTitle($this->_contactId); |
| 203 | |
| 204 | $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse'); |
| 205 | $this->assign('action', $this->_action); |
| 206 | } |
| 207 | |
| 208 | /** |
| 209 | * This function is the main function that is called when the page loads, |
| 210 | * it decides the which action has to be taken for the page. |
| 211 | * |
| 212 | * return null |
| 213 | * @access public |
| 214 | */ |
| 215 | function run() { |
| 216 | $this->preProcess(); |
| 217 | |
| 218 | $this->setContext(); |
| 219 | |
| 220 | $this->_caseId = CRM_Utils_Request::retrieve('caseID', 'Integer', $this); |
| 221 | |
| 222 | if ($this->_action & CRM_Core_Action::VIEW) { |
| 223 | $this->view(); |
| 224 | } |
| 225 | elseif ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD | CRM_Core_Action::DELETE)) { |
| 226 | $this->edit(); |
| 227 | } |
| 228 | elseif ($this->_action & CRM_Core_Action::DISABLE) { |
| 229 | CRM_Contact_BAO_Relationship::disableEnableRelationship($this->_id, CRM_Core_Action::DISABLE); |
| 230 | CRM_Contact_BAO_Relationship::setIsActive($this->_id, 0); |
| 231 | $session = CRM_Core_Session::singleton(); |
| 232 | CRM_Utils_System::redirect($session->popUserContext()); |
| 233 | } |
| 234 | elseif ($this->_action & CRM_Core_Action::ENABLE) { |
| 235 | CRM_Contact_BAO_Relationship::disableEnableRelationship($this->_id, CRM_Core_Action::ENABLE); |
| 236 | CRM_Contact_BAO_Relationship::setIsActive($this->_id, 1); |
| 237 | $session = CRM_Core_Session::singleton(); |
| 238 | CRM_Utils_System::redirect($session->popUserContext()); |
| 239 | } |
| 240 | |
| 241 | // if this is called from case view, suppress browse relationships form |
| 242 | else { |
| 243 | $this->browse(); |
| 244 | } |
| 245 | |
| 246 | return parent::run(); |
| 247 | } |
| 248 | |
| 249 | function setContext() { |
| 250 | $context = CRM_Utils_Request::retrieve('context', 'String', |
| 251 | $this, FALSE, 'search' |
| 252 | ); |
| 253 | |
| 254 | if ($context == 'dashboard') { |
| 255 | $cid = CRM_Utils_Request::retrieve('cid', 'Integer', |
| 256 | $this, FALSE |
| 257 | ); |
| 258 | $url = CRM_Utils_System::url('civicrm/user', |
| 259 | "reset=1&id={$cid}" |
| 260 | ); |
| 261 | } |
| 262 | else { |
| 263 | $url = CRM_Utils_System::url('civicrm/contact/view', 'action=browse&selectedChild=rel'); |
| 264 | } |
| 265 | $session = CRM_Core_Session::singleton(); |
| 266 | $session->pushUserContext($url); |
| 267 | } |
| 268 | |
| 269 | /** |
| 270 | * This function is called to delete the relationship of a contact |
| 271 | * |
| 272 | * return null |
| 273 | * @access public |
| 274 | */ |
| 275 | function delete() { |
| 276 | // calls a function to delete relationship |
| 277 | CRM_Contact_BAO_Relationship::del($this->_id); |
| 278 | } |
| 279 | |
| 280 | /** |
| 281 | * Get action links |
| 282 | * |
| 283 | * @return array (reference) of action links |
| 284 | * @static |
| 285 | */ |
| 286 | static function &links() { |
| 287 | if (!(self::$_links)) { |
| 288 | self::$_links = array( |
| 289 | CRM_Core_Action::VIEW => array( |
| 290 | 'name' => ts('View'), |
| 291 | 'url' => 'civicrm/contact/view/rel', |
| 292 | 'qs' => 'action=view&reset=1&cid=%%cid%%&id=%%id%%&rtype=%%rtype%%&selectedChild=rel', |
| 293 | 'title' => ts('View Relationship'), |
| 294 | ), |
| 295 | CRM_Core_Action::UPDATE => array( |
| 296 | 'name' => ts('Edit'), |
| 297 | 'url' => 'civicrm/contact/view/rel', |
| 298 | 'qs' => 'action=update&reset=1&cid=%%cid%%&id=%%id%%&rtype=%%rtype%%', |
| 299 | 'title' => ts('Edit Relationship'), |
| 300 | ), |
| 301 | CRM_Core_Action::ENABLE => array( |
| 302 | 'name' => ts('Enable'), |
| 303 | 'ref' => 'crm-enable-disable', |
| 304 | 'title' => ts('Enable Relationship'), |
| 305 | ), |
| 306 | CRM_Core_Action::DISABLE => array( |
| 307 | 'name' => ts('Disable'), |
| 308 | 'ref' => 'crm-enable-disable', |
| 309 | 'title' => ts('Disable Relationship'), |
| 310 | ), |
| 311 | CRM_Core_Action::DELETE => array( |
| 312 | 'name' => ts('Delete'), |
| 313 | 'url' => 'civicrm/contact/view/rel', |
| 314 | 'qs' => 'action=delete&reset=1&cid=%%cid%%&id=%%id%%&rtype=%%rtype%%', |
| 315 | 'title' => ts('Delete Relationship'), |
| 316 | ), |
| 317 | // FIXME: Not sure what to put as the key. |
| 318 | // We want to use it differently later anyway (see CRM_Contact_BAO_Relationship::getRelationship). NONE should make it hidden by default. |
| 319 | CRM_Core_Action::NONE => array( |
| 320 | 'name' => ts('Manage Case'), |
| 321 | 'url' => 'civicrm/contact/view/case', |
| 322 | 'qs' => 'action=view&reset=1&cid=%%clientid%%&id=%%caseid%%', |
| 323 | 'title' => ts('Manage Case'), |
| 324 | ), |
| 325 | ); |
| 326 | } |
| 327 | return self::$_links; |
| 328 | } |
| 329 | } |
| 330 | |