3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Contact_Page_View_Relationship
extends CRM_Core_Page
{
38 * The action links that we need to display for the browse screen
43 static $_links = NULL;
46 * Casid set if called from case context
50 public $_caseId = NULL;
52 public $_permission = NULL;
53 public $_contactId = NULL;
56 * View details of a relationship
61 public function view() {
62 $viewRelationship = CRM_Contact_BAO_Relationship
::getRelationship($this->_contactId
, NULL, NULL, NULL, $this->_id
);
63 //To check whether selected contact is a contact_id_a in
64 //relationship type 'a_b' in relationship table, if yes then
65 //revert the permissionship text in template
66 $relationship = new CRM_Contact_DAO_Relationship();
67 $relationship->id
= $viewRelationship[$this->_id
]['id'];
69 if ($relationship->find(TRUE)) {
70 if (($viewRelationship[$this->_id
]['rtype'] == 'a_b') && ($this->_contactId
== $relationship->contact_id_a
)) {
71 $this->assign("is_contact_id_a", TRUE);
74 $relType = $viewRelationship[$this->_id
]['civicrm_relationship_type_id'];
75 $this->assign('viewRelationship', $viewRelationship);
77 $employerId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId
, 'employer_id');
78 $this->assign('isCurrentEmployer', FALSE);
80 $relTypes = CRM_Utils_Array
::index(array('name_a_b'), CRM_Core_PseudoConstant
::relationshipType('name'));
82 if ($viewRelationship[$this->_id
]['employer_id'] == $this->_contactId
) {
83 $this->assign('isCurrentEmployer', TRUE);
85 elseif ($relType == $relTypes['Employee of']['id'] &&
86 ($viewRelationship[$this->_id
]['cid'] == $employerId)
88 // make sure we are viewing employee of relationship
89 $this->assign('isCurrentEmployer', TRUE);
92 $viewNote = CRM_Core_BAO_Note
::getNote($this->_id
);
93 $this->assign('viewNote', $viewNote);
95 $groupTree = CRM_Core_BAO_CustomGroup
::getTree('Relationship', $this, $this->_id
, 0, $relType);
96 CRM_Core_BAO_CustomGroup
::buildCustomDataView($this, $groupTree);
98 $rType = CRM_Utils_Array
::value('rtype', $viewRelationship[$this->_id
]);
99 // add viewed contribution to recent items list
100 $url = CRM_Utils_System
::url('civicrm/contact/view/rel',
101 "action=view&reset=1&id={$viewRelationship[$this->_id]['id']}&cid={$this->_contactId}&context=home"
104 $session = CRM_Core_Session
::singleton();
105 $recentOther = array();
107 if (($session->get('userID') == $this->_contactId
) ||
108 CRM_Contact_BAO_Contact_Permission
::allow($this->_contactId
, CRM_Core_Permission
::EDIT
)
110 $recentOther = array(
111 'editUrl' => CRM_Utils_System
::url('civicrm/contact/view/rel',
112 "action=update&reset=1&id={$viewRelationship[$this->_id]['id']}&cid={$this->_contactId}&rtype={$rType}&context=home"
114 'deleteUrl' => CRM_Utils_System
::url('civicrm/contact/view/rel',
115 "action=delete&reset=1&id={$viewRelationship[$this->_id]['id']}&cid={$this->_contactId}&rtype={$rType}&context=home"
120 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactId
);
121 $this->assign('displayName', $displayName);
122 CRM_Utils_System
::setTitle(ts('View Relationship for') . ' ' . $displayName);
124 $title = $displayName . ' (' . $viewRelationship[$this->_id
]['relation'] . ' ' . CRM_Contact_BAO_Contact
::displayName($viewRelationship[$this->_id
]['cid']) . ')';
126 // add the recently viewed Relationship
127 CRM_Utils_Recent
::add($title,
129 $viewRelationship[$this->_id
]['id'],
138 * This function is called when action is browse
142 public function browse() {
143 // do nothing :) we are using datatable for rendering relationship selectors
147 * This function is called when action is update or new
151 public function edit() {
152 $controller = new CRM_Core_Controller_Simple('CRM_Contact_Form_Relationship', ts('Contact Relationships'), $this->_action
);
153 $controller->setEmbedded(TRUE);
155 // set the userContext stack
156 $session = CRM_Core_Session
::singleton();
158 // if this is called from case view, we need to redirect back to same page
159 if ($this->_caseId
) {
160 $url = CRM_Utils_System
::url('civicrm/contact/view/case', "action=view&reset=1&cid={$this->_contactId}&id={$this->_caseId}");
163 $url = CRM_Utils_System
::url('civicrm/contact/view', "action=browse&selectedChild=rel&reset=1&cid={$this->_contactId}");
166 $session->pushUserContext($url);
168 if (CRM_Utils_Request
::retrieve('confirmed', 'Boolean',
169 CRM_Core_DAO
::$_nullObject
171 if ($this->_caseId
) {
172 //create an activity for case role removal.CRM-4480
173 CRM_Case_BAO_Case
::createCaseRoleActivity($this->_caseId
, $this->_id
);
174 CRM_Core_Session
::setStatus(ts('Case Role has been deleted successfully.'), ts('Record Deleted'), 'success');
177 // delete relationship
178 CRM_Contact_BAO_Relationship
::del($this->_id
);
180 CRM_Utils_System
::redirect($url);
183 $controller->set('contactId', $this->_contactId
);
184 $controller->set('id', $this->_id
);
185 $controller->process();
189 public function preProcess() {
190 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
191 $this->_contactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this, TRUE);
192 $this->assign('contactId', $this->_contactId
);
194 // check logged in url permission
195 CRM_Contact_Page_View
::checkUserPermission($this);
197 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'browse');
198 $this->assign('action', $this->_action
);
202 * This function is the main function that is called when the page loads,
203 * it decides the which action has to be taken for the page.
207 public function run() {
212 $this->_caseId
= CRM_Utils_Request
::retrieve('caseID', 'Integer', $this);
214 if ($this->_action
& CRM_Core_Action
::VIEW
) {
217 elseif ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD | CRM_Core_Action
::DELETE
)) {
220 elseif ($this->_action
& CRM_Core_Action
::DISABLE
) {
221 CRM_Contact_BAO_Relationship
::disableEnableRelationship($this->_id
, CRM_Core_Action
::DISABLE
);
222 CRM_Contact_BAO_Relationship
::setIsActive($this->_id
, 0);
223 $session = CRM_Core_Session
::singleton();
224 CRM_Utils_System
::redirect($session->popUserContext());
226 elseif ($this->_action
& CRM_Core_Action
::ENABLE
) {
227 CRM_Contact_BAO_Relationship
::disableEnableRelationship($this->_id
, CRM_Core_Action
::ENABLE
);
228 CRM_Contact_BAO_Relationship
::setIsActive($this->_id
, 1);
229 $session = CRM_Core_Session
::singleton();
230 CRM_Utils_System
::redirect($session->popUserContext());
233 // if this is called from case view, suppress browse relationships form
238 return parent
::run();
241 public function setContext() {
242 $context = CRM_Utils_Request
::retrieve('context', 'String',
243 $this, FALSE, 'search'
246 if ($context == 'dashboard') {
247 $cid = CRM_Utils_Request
::retrieve('cid', 'Integer',
250 $url = CRM_Utils_System
::url('civicrm/user',
255 $url = CRM_Utils_System
::url('civicrm/contact/view', 'action=browse&selectedChild=rel');
257 $session = CRM_Core_Session
::singleton();
258 $session->pushUserContext($url);
262 * This function is called to delete the relationship of a contact
266 public function delete() {
267 // calls a function to delete relationship
268 CRM_Contact_BAO_Relationship
::del($this->_id
);
274 * @return array (reference) of action links
277 public static function &links() {
278 if (!(self
::$_links)) {
279 self
::$_links = array(
280 CRM_Core_Action
::VIEW
=> array(
281 'name' => ts('View'),
282 'url' => 'civicrm/contact/view/rel',
283 'qs' => 'action=view&reset=1&cid=%%cid%%&id=%%id%%&rtype=%%rtype%%&selectedChild=rel',
284 'title' => ts('View Relationship'),
286 CRM_Core_Action
::UPDATE
=> array(
287 'name' => ts('Edit'),
288 'url' => 'civicrm/contact/view/rel',
289 'qs' => 'action=update&reset=1&cid=%%cid%%&id=%%id%%&rtype=%%rtype%%',
290 'title' => ts('Edit Relationship'),
292 CRM_Core_Action
::ENABLE
=> array(
293 'name' => ts('Enable'),
294 'ref' => 'crm-enable-disable',
295 'title' => ts('Enable Relationship'),
297 CRM_Core_Action
::DISABLE
=> array(
298 'name' => ts('Disable'),
299 'ref' => 'crm-enable-disable',
300 'title' => ts('Disable Relationship'),
302 CRM_Core_Action
::DELETE
=> array(
303 'name' => ts('Delete'),
304 'url' => 'civicrm/contact/view/rel',
305 'qs' => 'action=delete&reset=1&cid=%%cid%%&id=%%id%%&rtype=%%rtype%%',
306 'title' => ts('Delete Relationship'),
308 // FIXME: Not sure what to put as the key.
309 // We want to use it differently later anyway (see CRM_Contact_BAO_Relationship::getRelationship). NONE should make it hidden by default.
310 CRM_Core_Action
::NONE
=> array(
311 'name' => ts('Manage Case'),
312 'url' => 'civicrm/contact/view/case',
313 'qs' => 'action=view&reset=1&cid=%%clientid%%&id=%%caseid%%',
314 'title' => ts('Manage Case'),
318 return self
::$_links;