CRM/Contact/Page/View/Summary.php

   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     $session = CRM_Core_Session::singleton();
 141     $url = CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $this->_contactId);
 142     $session->pushUserContext($url);
 143
 144     $params   = array();
 145     $defaults = array();
 146     $ids      = array();
 147
 148     $params['id'] = $params['contact_id'] = $this->_contactId;
 149     $params['noRelationships'] = $params['noNotes'] = $params['noGroups'] = TRUE;
 150     $contact = CRM_Contact_BAO_Contact::retrieve($params, $defaults, TRUE);
 151
 152     $communicationType = array(
 153       'phone' => array(
 154         'type' => 'phoneType',
 155         'id' => 'phone_type',
 156         'daoName' => 'CRM_Core_DAO_Phone',
 157         'fieldName' => 'phone_type_id',
 158       ),
 159       'im' => array(
 160         'type' => 'IMProvider',
 161         'id' => 'provider',
 162         'daoName' => 'CRM_Core_DAO_IM',
 163         'fieldName' => 'provider_id',
 164       ),
 165       'website' => array(
 166         'type' => 'websiteType',
 167         'id' => 'website_type',
 168         'daoName' => 'CRM_Core_DAO_Website',
 169         'fieldName' => 'website_type_id',
 170       ),
 171       'address' => array('skip' => TRUE, 'customData' => 1),
 172       'email' => array('skip' => TRUE),
 173       'openid' => array('skip' => TRUE),
 174     );
 175
 176     foreach ($communicationType as $key => $value) {
 177       if (CRM_Utils_Array::value($key, $defaults)) {
 178         foreach ($defaults[$key] as & $val) {
 179           CRM_Utils_Array::lookupValue($val, 'location_type', CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', array('labelColumn' => 'display_name')), FALSE);
 180           if (!CRM_Utils_Array::value('skip', $value)) {
 181             $daoName = $value['daoName'];
 182             $pseudoConst = $daoName::buildOptions($value['fieldName'], 'get');
 183             CRM_Utils_Array::lookupValue($val, $value['id'], $pseudoConst, FALSE);
 184           }
 185         }
 186         if (isset($value['customData'])) {
 187           foreach ($defaults[$key] as $blockId => $blockVal) {
 188             $idValue = $blockVal['id'];
 189             if ( $key == 'address' ) {
 190               if ( CRM_Utils_Array::value( 'master_id', $blockVal ) ) {
 191                 $idValue = $blockVal['master_id'];
 192               }
 193             }
 194             $groupTree = CRM_Core_BAO_CustomGroup::getTree(ucfirst($key),
 195               $this,
 196               $idValue
 197             );
 198             // we setting the prefix to dnc_ below so that we don't overwrite smarty's grouptree var.
 199             $defaults[$key][$blockId]['custom'] = CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree, FALSE, NULL, "dnc_");
 200           }
 201           // reset template variable since that won't be of any use, and could be misleading
 202           $this->assign("dnc_viewCustomData", NULL);
 203         }
 204       }
 205     }
 206
 207     if (CRM_Utils_Array::value('gender_id', $defaults)) {
 208       $gender = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id', array('localize' => TRUE));
 209       $defaults['gender_display'] = $gender[CRM_Utils_Array::value('gender_id', $defaults)];
 210     }
 211
 212     // to make contact type label available in the template -
 213     $contactType = array_key_exists('contact_sub_type', $defaults) ? $defaults['contact_sub_type'] : $defaults['contact_type'];
 214     $defaults['contact_type_label'] = CRM_Contact_BAO_ContactType::contactTypePairs(TRUE, $contactType, ', ');
 215
 216     // get contact tags
 217     $contactTags = CRM_Core_BAO_EntityTag::getContactTags($this->_contactId);
 218
 219     if (!empty($contactTags)) {
 220       $defaults['contactTag'] = implode(', ', $contactTags);
 221     }
 222
 223     $defaults['privacy_values'] = CRM_Core_SelectValues::privacy();
 224
 225     //Show blocks only if they are visible in edit form
 226     $this->_editOptions = CRM_Core_BAO_Setting::valueOptions(
 227       CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 228       'contact_edit_options'
 229     );
 230
 231     foreach ($this->_editOptions as $blockName => $value) {
 232       $varName = '_show' . $blockName;
 233       $this->$varName = $value;
 234       $this->assign(substr($varName, 1), $this->$varName);
 235     }
 236
 237     // get contact name of shared contact names
 238     $sharedAddresses = array();
 239     $shareAddressContactNames = CRM_Contact_BAO_Contact_Utils::getAddressShareContactNames($defaults['address']);
 240     foreach ($defaults['address'] as $key => $addressValue) {
 241       if (CRM_Utils_Array::value('master_id', $addressValue) &&
 242         !$shareAddressContactNames[$addressValue['master_id']]['is_deleted']
 243       ) {
 244         $sharedAddresses[$key]['shared_address_display'] = array(
 245           'address' => $addressValue['display'],
 246           'name' => $shareAddressContactNames[$addressValue['master_id']]['name'],
 247         );
 248       }
 249     }
 250     $this->assign('sharedAddresses', $sharedAddresses);
 251
 252     //get the current employer name
 253     if (CRM_Utils_Array::value('contact_type', $defaults) == 'Individual') {
 254       if ($contact->employer_id && $contact->organization_name) {
 255         $defaults['current_employer'] = $contact->organization_name;
 256         $defaults['current_employer_id'] = $contact->employer_id;
 257       }
 258
 259       //for birthdate format with respect to birth format set
 260       $this->assign('birthDateViewFormat', CRM_Utils_Array::value('qfMapping', CRM_Utils_Date::checkBirthDateFormat()));
 261     }
 262
 263     $this->assign($defaults);
 264
 265     // FIXME: when we sort out TZ isssues with DATETIME/TIMESTAMP, we can skip next query
 266     // also assign the last modifed details
 267     $lastModified = CRM_Core_BAO_Log::lastModified($this->_contactId, 'civicrm_contact');
 268     $this->assign_by_ref('lastModified', $lastModified);
 269
 270     $allTabs = array();
 271     $weight = 10;
 272
 273     $this->_viewOptions = CRM_Core_BAO_Setting::valueOptions(
 274       CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 275       'contact_view_options',
 276       TRUE
 277     );
 278
 279     // show the tabs only if user has generic access to CiviCRM
 280     $accessCiviCRM = CRM_Core_Permission::check('access CiviCRM');
 281
 282     $changeLog = $this->_viewOptions['log'];
 283     $this->assign_by_ref('changeLog', $changeLog);
 284     $components = CRM_Core_Component::getEnabledComponents();
 285
 286     foreach ($components as $name => $component) {
 287       if (
 288         CRM_Utils_Array::value($name, $this->_viewOptions) &&
 289         CRM_Core_Permission::access($component->name)
 290       ) {
 291         $elem = $component->registerTab();
 292
 293         // FIXME: not very elegant, probably needs better approach
 294         // allow explicit id, if not defined, use keyword instead
 295         if (array_key_exists('id', $elem)) {
 296           $i = $elem['id'];
 297         }
 298         else {
 299           $i = $component->getKeyword();
 300         }
 301         $u = $elem['url'];
 302
 303         //appending isTest to url for test soft credit CRM-3891.
 304         //FIXME: hack ajax url.
 305         $q = "reset=1&snippet=1&force=1&cid={$this->_contactId}";
 306         if (CRM_Utils_Request::retrieve('isTest', 'Positive', $this)) {
 307           $q = $q . "&isTest=1";
 308         }
 309         $allTabs[] = array(
 310           'id' => $i,
 311           'url' => CRM_Utils_System::url("civicrm/contact/view/$u", $q),
 312           'title' => $elem['title'],
 313           'weight' => $elem['weight'],
 314           'count' => CRM_Contact_BAO_Contact::getCountComponent($u, $this->_contactId),
 315         );
 316         // make sure to get maximum weight, rest of tabs go after
 317         // FIXME: not very elegant again
 318         if ($weight < $elem['weight']) {
 319           $weight = $elem['weight'];
 320         }
 321       }
 322     }
 323
 324     $rest = array(
 325       'activity' => ts('Activities'),
 326       'case' => ts('Cases'),
 327       'rel' => ts('Relationships'),
 328       'group' => ts('Groups'),
 329       'note' => ts('Notes'),
 330       'tag' => ts('Tags'),
 331       'log' => ts('Change Log'),
 332     );
 333
 334     foreach ($rest as $k => $v) {
 335       if ($accessCiviCRM && CRM_Utils_Array::value($k, $this->_viewOptions)) {
 336         $allTabs[] = array(
 337           'id' => $k,
 338           'url' => CRM_Utils_System::url(
 339             "civicrm/contact/view/$k",
 340             "reset=1&snippet=1&cid={$this->_contactId}"
 341           ),
 342           'title' => $v,
 343           'weight' => $weight,
 344           'count' => CRM_Contact_BAO_Contact::getCountComponent($k, $this->_contactId),
 345         );
 346         $weight += 10;
 347       }
 348     }
 349
 350     // now add all the custom tabs
 351     $entityType = $this->get('contactType');
 352     $activeGroups = CRM_Core_BAO_CustomGroup::getActiveGroups(
 353       $entityType,
 354       'civicrm/contact/view/cd',
 355       $this->_contactId
 356     );
 357
 358     foreach ($activeGroups as $group) {
 359       $id = "custom_{$group['id']}";
 360       $allTabs[] = array(
 361         'id' => $id,
 362         'url' => CRM_Utils_System::url($group['path'], $group['query'] . "&snippet=1&selectedChild=$id"),
 363         'title' => $group['title'],
 364         'weight' => $weight,
 365         'count' => CRM_Contact_BAO_Contact::getCountComponent($id, $this->_contactId, $group['table_name']),
 366       );
 367       $weight += 10;
 368     }
 369
 370     // see if any other modules want to add any tabs
 371     CRM_Utils_Hook::tabs($allTabs, $this->_contactId);
 372
 373     // now sort the tabs based on weight
 374     usort($allTabs, array('CRM_Utils_Sort', 'cmpFunc'));
 375
 376     $this->assign('allTabs', $allTabs);
 377
 378     $selectedChild = CRM_Utils_Request::retrieve('selectedChild', 'String', $this, FALSE, 'summary');
 379     $this->assign('selectedChild', $selectedChild);
 380
 381     // hook for contact summary
 382     // ignored but needed to prevent warnings
 383     $contentPlacement = CRM_Utils_Hook::SUMMARY_BELOW;
 384     CRM_Utils_Hook::summary($this->_contactId, $content, $contentPlacement);
 385     if ($content) {
 386       $this->assign_by_ref('hookContent', $content);
 387       $this->assign('hookContentPlacement', $contentPlacement);
 388     }
 389   }
 390
 391   function getTemplateFileName() {
 392     if ($this->_contactId) {
 393       $csType = $this->get('contactSubtype');
 394       if ($csType) {
 395         $templateFile = "CRM/Contact/Page/View/SubType/{$csType}.tpl";
 396         $template = CRM_Core_Page::getTemplate();
 397         if ($template->template_exists($templateFile)) {
 398           return $templateFile;
 399         }
 400       }
 401     }
 402     return parent::getTemplateFileName();
 403   }
 404 }
 405