3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Main page for viewing contact.
21 class CRM_Contact_Page_View_Summary
extends CRM_Contact_Page_View
{
24 * Heart of the viewing process.
26 * The runner gets all the meta data for the contact and calls the appropriate type of page to view.
28 public function preProcess() {
31 // actions buttom contextMenu
32 $menuItems = CRM_Contact_BAO_Contact
::contextMenu($this->_contactId
);
34 $this->assign('actionsMenuList', $menuItems);
36 //retrieve inline custom data
37 $entityType = $this->get('contactType');
38 if ($entitySubType = $this->get('contactSubtype')) {
39 $entitySubType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
40 trim($entitySubType, CRM_Core_DAO
::VALUE_SEPARATOR
)
43 // Custom groups with VIEW permission
44 $visibleGroups = CRM_Core_BAO_CustomGroup
::getTree($entityType,
53 CRM_Core_Permission
::VIEW
56 CRM_Core_BAO_CustomGroup
::buildCustomDataView($this, $visibleGroups, FALSE, NULL, NULL, NULL, $this->_contactId
, CRM_Core_Permission
::EDIT
);
58 // also create the form element for the activity links box
59 $controller = new CRM_Core_Controller_Simple(
60 'CRM_Activity_Form_ActivityLinks',
67 $controller->setEmbedded(TRUE);
72 * Heart of the viewing process.
74 * The runner gets all the meta data for the contact and calls the appropriate type of page to view.
76 public function run() {
79 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
90 * Edit name and address of a contact.
92 public function edit() {
93 // set the userContext stack
94 $session = CRM_Core_Session
::singleton();
95 $url = CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $this->_contactId
);
96 $session->pushUserContext($url);
98 $controller = new CRM_Core_Controller_Simple('CRM_Contact_Form_Contact', ts('Contact Page'), CRM_Core_Action
::UPDATE
);
99 $controller->setEmbedded(TRUE);
100 $controller->process();
101 return $controller->run();
105 * View summary details of a contact.
107 public function view() {
108 // Add js for tabs, in-place editing, and jstree for tags
109 CRM_Core_Resources
::singleton()
110 ->addScriptFile('civicrm', 'templates/CRM/Contact/Page/View/Summary.js', 2, 'html-header')
111 ->addStyleFile('civicrm', 'css/contactSummary.css', 2, 'html-header')
112 ->addScriptFile('civicrm', 'templates/CRM/common/TabHeader.js', 1, 'html-header')
114 'summaryPrint' => array('mode' => $this->_print
),
115 'tabSettings' => array('active' => CRM_Utils_Request
::retrieve('selectedChild', 'Alphanumeric', $this, FALSE, 'summary')),
117 $this->assign('summaryPrint', $this->_print
);
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 $this->assignFieldMetadataToTemplate('Contact');
126 $params['id'] = $params['contact_id'] = $this->_contactId
;
127 $params['noRelationships'] = $params['noNotes'] = $params['noGroups'] = TRUE;
128 $contact = CRM_Contact_BAO_Contact
::retrieve($params, $defaults, TRUE);
129 // Let summary page know if outbound mail is disabled so email links can be built conditionally
130 $mailingBackend = Civi
::settings()->get('mailing_backend');
131 $this->assign('mailingOutboundOption', $mailingBackend['outBound_option']);
133 $communicationType = array(
135 'type' => 'phoneType',
136 'id' => 'phone_type',
137 'daoName' => 'CRM_Core_DAO_Phone',
138 'fieldName' => 'phone_type_id',
141 'type' => 'IMProvider',
143 'daoName' => 'CRM_Core_DAO_IM',
144 'fieldName' => 'provider_id',
147 'type' => 'websiteType',
148 'id' => 'website_type',
149 'daoName' => 'CRM_Core_DAO_Website',
150 'fieldName' => 'website_type_id',
152 'address' => array('skip' => TRUE, 'customData' => 1),
153 'email' => array('skip' => TRUE),
154 'openid' => array('skip' => TRUE),
157 foreach ($communicationType as $key => $value) {
158 if (!empty($defaults[$key])) {
159 foreach ($defaults[$key] as & $val) {
160 CRM_Utils_Array
::lookupValue($val, 'location_type', CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id', array('labelColumn' => 'display_name')), FALSE);
161 if (empty($value['skip'])) {
162 $daoName = $value['daoName'];
163 $pseudoConst = $daoName::buildOptions($value['fieldName'], 'get');
164 CRM_Utils_Array
::lookupValue($val, $value['id'], $pseudoConst, FALSE);
167 if (isset($value['customData'])) {
168 foreach ($defaults[$key] as $blockId => $blockVal) {
169 $idValue = $blockVal['id'];
170 if ($key == 'address') {
171 if (!empty($blockVal['master_id'])) {
172 $idValue = $blockVal['master_id'];
175 $groupTree = CRM_Core_BAO_CustomGroup
::getTree(ucfirst($key), NULL, $idValue, NULL, [],
176 NULL, TRUE, NULL, FALSE, CRM_Core_Permission
::VIEW
);
177 // we setting the prefix to dnc_ below so that we don't overwrite smarty's grouptree var.
178 $defaults[$key][$blockId]['custom'] = CRM_Core_BAO_CustomGroup
::buildCustomDataView($this, $groupTree, FALSE, NULL, "dnc_");
180 // reset template variable since that won't be of any use, and could be misleading
181 $this->assign("dnc_viewCustomData", NULL);
186 $defaults['gender_display'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'gender_id', $defaults['gender_id'] ??
NULL);
188 $communicationStyle = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'communication_style_id');
189 if (!empty($communicationStyle)) {
190 if (!empty($defaults['communication_style_id'])) {
191 $defaults['communication_style_display'] = $communicationStyle[$defaults['communication_style_id']];
194 // Make sure the field is displayed as long as it is active, even if it is unset for this contact.
195 $defaults['communication_style_display'] = '';
199 // to make contact type label available in the template -
200 $contactType = array_key_exists('contact_sub_type', $defaults) ?
$defaults['contact_sub_type'] : $defaults['contact_type'];
201 $defaults['contact_type_label'] = CRM_Contact_BAO_ContactType
::contactTypePairs(TRUE, $contactType, ', ');
204 $contactTags = CRM_Core_BAO_EntityTag
::getContactTags($this->_contactId
);
206 if (!empty($contactTags)) {
207 $defaults['contactTag'] = $contactTags;
208 $defaults['allTags'] = CRM_Core_BAO_Tag
::getTagsUsedFor('civicrm_contact', FALSE);
211 $defaults['privacy_values'] = CRM_Core_SelectValues
::privacy();
213 //Show blocks only if they are visible in edit form
214 $this->_editOptions
= CRM_Core_BAO_Setting
::valueOptions(
215 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
216 'contact_edit_options'
219 foreach ($this->_editOptions
as $blockName => $value) {
220 $varName = '_show' . $blockName;
221 $this->$varName = $value;
222 $this->assign(substr($varName, 1), $this->$varName);
225 // get contact name of shared contact names
226 $sharedAddresses = [];
227 $shareAddressContactNames = CRM_Contact_BAO_Contact_Utils
::getAddressShareContactNames($defaults['address']);
228 foreach ($defaults['address'] as $key => $addressValue) {
229 if (!empty($addressValue['master_id']) &&
230 !$shareAddressContactNames[$addressValue['master_id']]['is_deleted']
232 $sharedAddresses[$key]['shared_address_display'] = array(
233 'address' => $addressValue['display'],
234 'name' => $shareAddressContactNames[$addressValue['master_id']]['name'],
238 $this->assign('sharedAddresses', $sharedAddresses);
240 //get the current employer name
241 if (CRM_Utils_Array
::value('contact_type', $defaults) == 'Individual') {
242 if ($contact->employer_id
&& $contact->organization_name
) {
243 $defaults['current_employer'] = $contact->organization_name
;
244 $defaults['current_employer_id'] = $contact->employer_id
;
248 $defaults['external_identifier'] = $contact->external_identifier
;
249 $this->assign($defaults);
251 // FIXME: when we sort out TZ isssues with DATETIME/TIMESTAMP, we can skip next query
252 // also assign the last modifed details
253 $lastModified = CRM_Core_BAO_Log
::lastModified($this->_contactId
, 'civicrm_contact');
254 $this->assign_by_ref('lastModified', $lastModified);
256 $this->_viewOptions
= CRM_Core_BAO_Setting
::valueOptions(
257 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
258 'contact_view_options',
262 $changeLog = $this->_viewOptions
['log'];
263 $this->assign_by_ref('changeLog', $changeLog);
265 $this->assign('allTabs', $this->getTabs());
267 // hook for contact summary
268 // ignored but needed to prevent warnings
269 $contentPlacement = CRM_Utils_Hook
::SUMMARY_BELOW
;
270 CRM_Utils_Hook
::summary($this->_contactId
, $content, $contentPlacement);
272 $this->assign_by_ref('hookContent', $content);
273 $this->assign('hookContentPlacement', $contentPlacement);
280 public function getTemplateFileName() {
281 if ($this->_contactId
) {
282 $contactSubtypes = $this->get('contactSubtype') ?
explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $this->get('contactSubtype')) : [];
284 // there could be multiple subtypes. We check templates for each of the subtype, and return the first one found.
285 foreach ($contactSubtypes as $csType) {
287 $templateFile = "CRM/Contact/Page/View/SubType/{$csType}.tpl";
288 $template = CRM_Core_Page
::getTemplate();
289 if ($template->template_exists($templateFile)) {
290 return $templateFile;
295 return parent
::getTemplateFileName();
301 public static function basicTabs() {
305 'template' => 'CRM/Contact/Page/View/Summary-tab.tpl',
306 'title' => ts('Summary'),
308 'icon' => 'crm-i fa-address-card-o',
312 'title' => ts('Activities'),
313 'class' => 'livePage',
315 'icon' => 'crm-i fa-tasks',
319 'title' => ts('Relationships'),
320 'class' => 'livePage',
322 'icon' => 'crm-i fa-handshake-o',
326 'title' => ts('Groups'),
327 'class' => 'ajaxForm',
329 'icon' => 'crm-i fa-users',
333 'title' => ts('Notes'),
334 'class' => 'livePage',
336 'icon' => 'crm-i fa-sticky-note-o',
340 'title' => ts('Tags'),
342 'icon' => 'crm-i fa-tags',
346 'title' => ts('Change Log'),
348 'icon' => 'crm-i fa-history',
355 * @throws \CRM_Core_Exception
357 public function getTabs() {
359 $getCountParams = [];
362 foreach (CRM_Core_Component
::getEnabledComponents() as $name => $component) {
363 if (!empty($this->_viewOptions
[$name]) &&
364 CRM_Core_Permission
::access($component->name
)
366 $elem = $component->registerTab();
368 // FIXME: not very elegant, probably needs better approach
369 // allow explicit id, if not defined, use keyword instead
370 $i = $elem['id'] ??
$component->getKeyword();
373 //appending isTest to url for test soft credit CRM-3891.
374 //FIXME: hack ajax url.
375 $q = "reset=1&force=1&cid={$this->_contactId}";
376 if (CRM_Utils_Request
::retrieve('isTest', 'Positive', $this)) {
381 'url' => CRM_Utils_System
::url("civicrm/contact/view/$u", $q),
382 'title' => $elem['title'],
383 'weight' => $elem['weight'],
385 'class' => 'livePage',
386 'icon' => $component->getIcon(),
388 $getCountParams[$i] = [$u, $this->_contactId
];
392 // show the tabs only if user has generic access to CiviCRM
393 $accessCiviCRM = CRM_Core_Permission
::check('access CiviCRM');
394 foreach (self
::basicTabs() as $tab) {
395 if ($tab['id'] == 'summary') {
398 elseif ($accessCiviCRM && !empty($this->_viewOptions
[$tab['id']])) {
399 $allTabs[] = $tab +
[
400 'url' => CRM_Utils_System
::url("civicrm/contact/view/{$tab['id']}", "reset=1&cid={$this->_contactId}"),
403 $getCountParams[$tab['id']] = [$tab['id'], $this->_contactId
];
404 $weight = $tab['weight'] +
10;
408 // now add all the custom tabs
409 $entityType = $this->get('contactType');
410 $activeGroups = CRM_Core_BAO_CustomGroup
::getActiveGroups(
412 'civicrm/contact/view/cd',
416 foreach ($activeGroups as $group) {
417 $id = "custom_{$group['id']}";
420 'url' => CRM_Utils_System
::url($group['path'], $group['query'] . "&selectedChild=$id"),
421 'title' => $group['title'],
424 'hideCount' => !$group['is_multiple'],
425 'class' => 'livePage',
426 'icon' => 'crm-i ' . ($group['icon'] ?
: 'fa-gear'),
428 $getCountParams[$id] = [$id, $this->_contactId
, $group['table_name']];
432 // Allow other modules to add or remove tabs
433 $context = ['contact_id' => $this->_contactId
];
434 CRM_Utils_Hook
::tabset('civicrm/contact/view', $allTabs, $context);
436 $expectedKeys = ['count', 'class', 'template', 'hideCount', 'icon'];
438 foreach ($allTabs as &$tab) {
439 // Ensure tab has all expected keys
440 $tab +
= array_fill_keys($expectedKeys, NULL);
441 // Get tab counts last to avoid wasting time; if a tab was removed by hook, the count isn't needed.
442 if (!isset($tab['count']) && isset($getCountParams[$tab['id']])) {
443 $tab['count'] = call_user_func_array(['CRM_Contact_BAO_Contact', 'getCountComponent'], $getCountParams[$tab['id']]);
447 // now sort the tabs based on weight
448 usort($allTabs, ['CRM_Utils_Sort', 'cmpFunc']);