| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.4 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2013 | |
| 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-2013 |
| 32 | * $Id$ |
| 33 | * |
| 34 | */ |
| 35 | |
| 36 | /** |
| 37 | * Main page for viewing contact. |
| 38 | * |
| 39 | */ |
| 40 | class CRM_Contact_Page_View_Summary extends CRM_Contact_Page_View { |
| 41 | |
| 42 | /** |
| 43 | * Heart of the viewing process. The runner gets all the meta data for |
| 44 | * the contact and calls the appropriate type of page to view. |
| 45 | * |
| 46 | * @return void |
| 47 | * @access public |
| 48 | * |
| 49 | */ |
| 50 | function preProcess() { |
| 51 | parent::preProcess(); |
| 52 | |
| 53 | // actions buttom contextMenu |
| 54 | $menuItems = CRM_Contact_BAO_Contact::contextMenu($this->_contactId); |
| 55 | |
| 56 | $this->assign('actionsMenuList', $menuItems); |
| 57 | |
| 58 | //retrieve inline custom data |
| 59 | $entityType = $this->get('contactType'); |
| 60 | if ($entitySubType = $this->get('contactSubtype')) { |
| 61 | $entitySubType = explode(CRM_Core_DAO::VALUE_SEPARATOR, |
| 62 | trim($entitySubType, CRM_Core_DAO::VALUE_SEPARATOR) |
| 63 | ); |
| 64 | } |
| 65 | $groupTree = &CRM_Core_BAO_CustomGroup::getTree($entityType, |
| 66 | $this, |
| 67 | $this->_contactId, |
| 68 | NULL, |
| 69 | $entitySubType |
| 70 | ); |
| 71 | |
| 72 | CRM_Core_BAO_CustomGroup::buildCustomDataView($this, |
| 73 | $groupTree |
| 74 | ); |
| 75 | |
| 76 | // also create the form element for the activity links box |
| 77 | $controller = new CRM_Core_Controller_Simple( |
| 78 | 'CRM_Activity_Form_ActivityLinks', |
| 79 | ts('Activity Links'), |
| 80 | NULL, |
| 81 | FALSE, |
| 82 | FALSE, |
| 83 | TRUE |
| 84 | ); |
| 85 | $controller->setEmbedded(TRUE); |
| 86 | $controller->run(); |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * Heart of the viewing process. The runner gets all the meta data for |
| 91 | * the contact and calls the appropriate type of page to view. |
| 92 | * |
| 93 | * @return void |
| 94 | * @access public |
| 95 | * |
| 96 | */ |
| 97 | function run() { |
| 98 | $this->preProcess(); |
| 99 | |
| 100 | if ($this->_action & CRM_Core_Action::UPDATE) { |
| 101 | $this->edit(); |
| 102 | } |
| 103 | else { |
| 104 | $this->view(); |
| 105 | } |
| 106 | |
| 107 | return parent::run(); |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * Edit name and address of a contact |
| 112 | * |
| 113 | * @return void |
| 114 | * @access public |
| 115 | */ |
| 116 | function edit() { |
| 117 | // set the userContext stack |
| 118 | $session = CRM_Core_Session::singleton(); |
| 119 | $url = CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $this->_contactId); |
| 120 | $session->pushUserContext($url); |
| 121 | |
| 122 | $controller = new CRM_Core_Controller_Simple('CRM_Contact_Form_Contact', ts('Contact Page'), CRM_Core_Action::UPDATE); |
| 123 | $controller->setEmbedded(TRUE); |
| 124 | $controller->process(); |
| 125 | return $controller->run(); |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * View summary details of a contact |
| 130 | * |
| 131 | * @return void |
| 132 | * @access public |
| 133 | */ |
| 134 | function view() { |
| 135 | // Add js for in-place editing and jstree for tags |
| 136 | CRM_Core_Resources::singleton() |
| 137 | ->addScriptFile('civicrm', 'templates/CRM/Contact/Page/View/Summary.js') |
| 138 | ->addScriptFile('civicrm', 'packages/jquery/plugins/jstree/jquery.jstree.js', 0, 'html-header', FALSE) |
| 139 | ->addStyleFile('civicrm', 'packages/jquery/plugins/jstree/themes/default/style.css', 0, 'html-header') |
| 140 | ->addSetting(array('summaryPrint' => array('mode' => $this->_print))); |
| 141 | $this->assign('summaryPrint', $this->_print); |
| 142 | $session = CRM_Core_Session::singleton(); |
| 143 | $url = CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $this->_contactId); |
| 144 | $session->pushUserContext($url); |
| 145 | |
| 146 | $params = array(); |
| 147 | $defaults = array(); |
| 148 | $ids = array(); |
| 149 | |
| 150 | $params['id'] = $params['contact_id'] = $this->_contactId; |
| 151 | $params['noRelationships'] = $params['noNotes'] = $params['noGroups'] = TRUE; |
| 152 | $contact = CRM_Contact_BAO_Contact::retrieve($params, $defaults, TRUE); |
| 153 | |
| 154 | $communicationType = array( |
| 155 | 'phone' => array( |
| 156 | 'type' => 'phoneType', |
| 157 | 'id' => 'phone_type', |
| 158 | 'daoName' => 'CRM_Core_DAO_Phone', |
| 159 | 'fieldName' => 'phone_type_id', |
| 160 | ), |
| 161 | 'im' => array( |
| 162 | 'type' => 'IMProvider', |
| 163 | 'id' => 'provider', |
| 164 | 'daoName' => 'CRM_Core_DAO_IM', |
| 165 | 'fieldName' => 'provider_id', |
| 166 | ), |
| 167 | 'website' => array( |
| 168 | 'type' => 'websiteType', |
| 169 | 'id' => 'website_type', |
| 170 | 'daoName' => 'CRM_Core_DAO_Website', |
| 171 | 'fieldName' => 'website_type_id', |
| 172 | ), |
| 173 | 'address' => array('skip' => TRUE, 'customData' => 1), |
| 174 | 'email' => array('skip' => TRUE), |
| 175 | 'openid' => array('skip' => TRUE), |
| 176 | ); |
| 177 | |
| 178 | foreach ($communicationType as $key => $value) { |
| 179 | if (CRM_Utils_Array::value($key, $defaults)) { |
| 180 | foreach ($defaults[$key] as & $val) { |
| 181 | CRM_Utils_Array::lookupValue($val, 'location_type', CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', array('labelColumn' => 'display_name')), FALSE); |
| 182 | if (!CRM_Utils_Array::value('skip', $value)) { |
| 183 | $daoName = $value['daoName']; |
| 184 | $pseudoConst = $daoName::buildOptions($value['fieldName'], 'get'); |
| 185 | CRM_Utils_Array::lookupValue($val, $value['id'], $pseudoConst, FALSE); |
| 186 | } |
| 187 | } |
| 188 | if (isset($value['customData'])) { |
| 189 | foreach ($defaults[$key] as $blockId => $blockVal) { |
| 190 | $idValue = $blockVal['id']; |
| 191 | if ( $key == 'address' ) { |
| 192 | if ( CRM_Utils_Array::value( 'master_id', $blockVal ) ) { |
| 193 | $idValue = $blockVal['master_id']; |
| 194 | } |
| 195 | } |
| 196 | $groupTree = CRM_Core_BAO_CustomGroup::getTree(ucfirst($key), |
| 197 | $this, |
| 198 | $idValue |
| 199 | ); |
| 200 | // we setting the prefix to dnc_ below so that we don't overwrite smarty's grouptree var. |
| 201 | $defaults[$key][$blockId]['custom'] = CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree, FALSE, NULL, "dnc_"); |
| 202 | } |
| 203 | // reset template variable since that won't be of any use, and could be misleading |
| 204 | $this->assign("dnc_viewCustomData", NULL); |
| 205 | } |
| 206 | } |
| 207 | } |
| 208 | |
| 209 | if (CRM_Utils_Array::value('gender_id', $defaults)) { |
| 210 | $gender = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id', array('localize' => TRUE)); |
| 211 | $defaults['gender_display'] = $gender[CRM_Utils_Array::value('gender_id', $defaults)]; |
| 212 | } |
| 213 | |
| 214 | $communicationStyle = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'communication_style_id'); |
| 215 | if (!empty($communicationStyle)) { |
| 216 | if (CRM_Utils_Array::value('communication_style_id', $defaults)) { |
| 217 | $defaults['communication_style_display'] = $communicationStyle[CRM_Utils_Array::value('communication_style_id', $defaults)]; |
| 218 | } |
| 219 | else { |
| 220 | // Make sure the field is displayed as long as it is active, even if it is unset for this contact. |
| 221 | $defaults['communication_style_display'] = ''; |
| 222 | } |
| 223 | } |
| 224 | |
| 225 | // to make contact type label available in the template - |
| 226 | $contactType = array_key_exists('contact_sub_type', $defaults) ? $defaults['contact_sub_type'] : $defaults['contact_type']; |
| 227 | $defaults['contact_type_label'] = CRM_Contact_BAO_ContactType::contactTypePairs(TRUE, $contactType, ', '); |
| 228 | |
| 229 | // get contact tags |
| 230 | $contactTags = CRM_Core_BAO_EntityTag::getContactTags($this->_contactId); |
| 231 | |
| 232 | if (!empty($contactTags)) { |
| 233 | $defaults['contactTag'] = implode(', ', $contactTags); |
| 234 | } |
| 235 | |
| 236 | $defaults['privacy_values'] = CRM_Core_SelectValues::privacy(); |
| 237 | |
| 238 | //Show blocks only if they are visible in edit form |
| 239 | $this->_editOptions = CRM_Core_BAO_Setting::valueOptions( |
| 240 | CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, |
| 241 | 'contact_edit_options' |
| 242 | ); |
| 243 | |
| 244 | foreach ($this->_editOptions as $blockName => $value) { |
| 245 | $varName = '_show' . $blockName; |
| 246 | $this->$varName = $value; |
| 247 | $this->assign(substr($varName, 1), $this->$varName); |
| 248 | } |
| 249 | |
| 250 | // get contact name of shared contact names |
| 251 | $sharedAddresses = array(); |
| 252 | $shareAddressContactNames = CRM_Contact_BAO_Contact_Utils::getAddressShareContactNames($defaults['address']); |
| 253 | foreach ($defaults['address'] as $key => $addressValue) { |
| 254 | if (CRM_Utils_Array::value('master_id', $addressValue) && |
| 255 | !$shareAddressContactNames[$addressValue['master_id']]['is_deleted'] |
| 256 | ) { |
| 257 | $sharedAddresses[$key]['shared_address_display'] = array( |
| 258 | 'address' => $addressValue['display'], |
| 259 | 'name' => $shareAddressContactNames[$addressValue['master_id']]['name'], |
| 260 | ); |
| 261 | } |
| 262 | } |
| 263 | $this->assign('sharedAddresses', $sharedAddresses); |
| 264 | |
| 265 | //get the current employer name |
| 266 | if (CRM_Utils_Array::value('contact_type', $defaults) == 'Individual') { |
| 267 | if ($contact->employer_id && $contact->organization_name) { |
| 268 | $defaults['current_employer'] = $contact->organization_name; |
| 269 | $defaults['current_employer_id'] = $contact->employer_id; |
| 270 | } |
| 271 | |
| 272 | //for birthdate format with respect to birth format set |
| 273 | $this->assign('birthDateViewFormat', CRM_Utils_Array::value('qfMapping', CRM_Utils_Date::checkBirthDateFormat())); |
| 274 | } |
| 275 | |
| 276 | $this->assign($defaults); |
| 277 | |
| 278 | // FIXME: when we sort out TZ isssues with DATETIME/TIMESTAMP, we can skip next query |
| 279 | // also assign the last modifed details |
| 280 | $lastModified = CRM_Core_BAO_Log::lastModified($this->_contactId, 'civicrm_contact'); |
| 281 | $this->assign_by_ref('lastModified', $lastModified); |
| 282 | |
| 283 | $allTabs = array(); |
| 284 | $weight = 10; |
| 285 | |
| 286 | $this->_viewOptions = CRM_Core_BAO_Setting::valueOptions( |
| 287 | CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, |
| 288 | 'contact_view_options', |
| 289 | TRUE |
| 290 | ); |
| 291 | |
| 292 | // show the tabs only if user has generic access to CiviCRM |
| 293 | $accessCiviCRM = CRM_Core_Permission::check('access CiviCRM'); |
| 294 | |
| 295 | $changeLog = $this->_viewOptions['log']; |
| 296 | $this->assign_by_ref('changeLog', $changeLog); |
| 297 | $components = CRM_Core_Component::getEnabledComponents(); |
| 298 | |
| 299 | foreach ($components as $name => $component) { |
| 300 | if ( |
| 301 | CRM_Utils_Array::value($name, $this->_viewOptions) && |
| 302 | CRM_Core_Permission::access($component->name) |
| 303 | ) { |
| 304 | $elem = $component->registerTab(); |
| 305 | |
| 306 | // FIXME: not very elegant, probably needs better approach |
| 307 | // allow explicit id, if not defined, use keyword instead |
| 308 | if (array_key_exists('id', $elem)) { |
| 309 | $i = $elem['id']; |
| 310 | } |
| 311 | else { |
| 312 | $i = $component->getKeyword(); |
| 313 | } |
| 314 | $u = $elem['url']; |
| 315 | |
| 316 | //appending isTest to url for test soft credit CRM-3891. |
| 317 | //FIXME: hack ajax url. |
| 318 | $q = "reset=1&snippet=1&force=1&cid={$this->_contactId}"; |
| 319 | if (CRM_Utils_Request::retrieve('isTest', 'Positive', $this)) { |
| 320 | $q = $q . "&isTest=1"; |
| 321 | } |
| 322 | $allTabs[] = array( |
| 323 | 'id' => $i, |
| 324 | 'url' => CRM_Utils_System::url("civicrm/contact/view/$u", $q), |
| 325 | 'title' => $elem['title'], |
| 326 | 'weight' => $elem['weight'], |
| 327 | 'count' => CRM_Contact_BAO_Contact::getCountComponent($u, $this->_contactId), |
| 328 | ); |
| 329 | // make sure to get maximum weight, rest of tabs go after |
| 330 | // FIXME: not very elegant again |
| 331 | if ($weight < $elem['weight']) { |
| 332 | $weight = $elem['weight']; |
| 333 | } |
| 334 | } |
| 335 | } |
| 336 | |
| 337 | $rest = array( |
| 338 | 'activity' => ts('Activities'), |
| 339 | 'case' => ts('Cases'), |
| 340 | 'rel' => ts('Relationships'), |
| 341 | 'group' => ts('Groups'), |
| 342 | 'note' => ts('Notes'), |
| 343 | 'tag' => ts('Tags'), |
| 344 | 'log' => ts('Change Log'), |
| 345 | ); |
| 346 | |
| 347 | foreach ($rest as $k => $v) { |
| 348 | if ($accessCiviCRM && CRM_Utils_Array::value($k, $this->_viewOptions)) { |
| 349 | $allTabs[] = array( |
| 350 | 'id' => $k, |
| 351 | 'url' => CRM_Utils_System::url( |
| 352 | "civicrm/contact/view/$k", |
| 353 | "reset=1&snippet=1&cid={$this->_contactId}" |
| 354 | ), |
| 355 | 'title' => $v, |
| 356 | 'weight' => $weight, |
| 357 | 'count' => CRM_Contact_BAO_Contact::getCountComponent($k, $this->_contactId), |
| 358 | ); |
| 359 | $weight += 10; |
| 360 | } |
| 361 | } |
| 362 | |
| 363 | // now add all the custom tabs |
| 364 | $entityType = $this->get('contactType'); |
| 365 | $activeGroups = CRM_Core_BAO_CustomGroup::getActiveGroups( |
| 366 | $entityType, |
| 367 | 'civicrm/contact/view/cd', |
| 368 | $this->_contactId |
| 369 | ); |
| 370 | |
| 371 | foreach ($activeGroups as $group) { |
| 372 | $id = "custom_{$group['id']}"; |
| 373 | $allTabs[] = array( |
| 374 | 'id' => $id, |
| 375 | 'url' => CRM_Utils_System::url($group['path'], $group['query'] . "&snippet=1&selectedChild=$id"), |
| 376 | 'title' => $group['title'], |
| 377 | 'weight' => $weight, |
| 378 | 'count' => CRM_Contact_BAO_Contact::getCountComponent($id, $this->_contactId, $group['table_name']), |
| 379 | ); |
| 380 | $weight += 10; |
| 381 | } |
| 382 | |
| 383 | // see if any other modules want to add any tabs |
| 384 | CRM_Utils_Hook::tabs($allTabs, $this->_contactId); |
| 385 | |
| 386 | // now sort the tabs based on weight |
| 387 | usort($allTabs, array('CRM_Utils_Sort', 'cmpFunc')); |
| 388 | |
| 389 | $this->assign('allTabs', $allTabs); |
| 390 | |
| 391 | $selectedChild = CRM_Utils_Request::retrieve('selectedChild', 'String', $this, FALSE, 'summary'); |
| 392 | $this->assign('selectedChild', $selectedChild); |
| 393 | |
| 394 | // hook for contact summary |
| 395 | // ignored but needed to prevent warnings |
| 396 | $contentPlacement = CRM_Utils_Hook::SUMMARY_BELOW; |
| 397 | CRM_Utils_Hook::summary($this->_contactId, $content, $contentPlacement); |
| 398 | if ($content) { |
| 399 | $this->assign_by_ref('hookContent', $content); |
| 400 | $this->assign('hookContentPlacement', $contentPlacement); |
| 401 | } |
| 402 | } |
| 403 | |
| 404 | function getTemplateFileName() { |
| 405 | if ($this->_contactId) { |
| 406 | $contactSubtypes = $this->get('contactSubtype') ? |
| 407 | explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->get('contactSubtype')) : array(); |
| 408 | |
| 409 | // there could be multiple subtypes. We check templates for each of the subtype, and return the first one found. |
| 410 | foreach ($contactSubtypes as $csType) { |
| 411 | if ($csType) { |
| 412 | $templateFile = "CRM/Contact/Page/View/SubType/{$csType}.tpl"; |
| 413 | $template = CRM_Core_Page::getTemplate(); |
| 414 | if ($template->template_exists($templateFile)) { |
| 415 | return $templateFile; |
| 416 | } |
| 417 | } |
| 418 | } |
| 419 | } |
| 420 | return parent::getTemplateFileName(); |
| 421 | } |
| 422 | } |
| 423 | |