3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
35 * Main page for viewing contact.
37 class CRM_Contact_Page_View_Summary
extends CRM_Contact_Page_View
{
40 * Heart of the viewing process.
42 * The runner gets all the meta data for the contact and calls the appropriate type of page to view.
44 public function preProcess() {
47 // actions buttom contextMenu
48 $menuItems = CRM_Contact_BAO_Contact
::contextMenu($this->_contactId
);
50 $this->assign('actionsMenuList', $menuItems);
52 //retrieve inline custom data
53 $entityType = $this->get('contactType');
54 if ($entitySubType = $this->get('contactSubtype')) {
55 $entitySubType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
56 trim($entitySubType, CRM_Core_DAO
::VALUE_SEPARATOR
)
59 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree($entityType,
66 CRM_Core_BAO_CustomGroup
::buildCustomDataView($this,
70 // also create the form element for the activity links box
71 $controller = new CRM_Core_Controller_Simple(
72 'CRM_Activity_Form_ActivityLinks',
79 $controller->setEmbedded(TRUE);
84 * Heart of the viewing process.
86 * The runner gets all the meta data for the contact and calls the appropriate type of page to view.
88 public function run() {
91 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
102 * Edit name and address of a contact.
104 public function edit() {
105 // set the userContext stack
106 $session = CRM_Core_Session
::singleton();
107 $url = CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $this->_contactId
);
108 $session->pushUserContext($url);
110 $controller = new CRM_Core_Controller_Simple('CRM_Contact_Form_Contact', ts('Contact Page'), CRM_Core_Action
::UPDATE
);
111 $controller->setEmbedded(TRUE);
112 $controller->process();
113 return $controller->run();
117 * View summary details of a contact.
119 public function view() {
120 // Add js for tabs, in-place editing, and jstree for tags
121 CRM_Core_Resources
::singleton()
122 ->addScriptFile('civicrm', 'templates/CRM/Contact/Page/View/Summary.js', 2, 'html-header')
123 ->addStyleFile('civicrm', 'css/contactSummary.css', 2, 'html-header')
124 ->addScriptFile('civicrm', 'packages/jquery/plugins/jstree/jquery.jstree.js', 0, 'html-header', FALSE)
125 ->addStyleFile('civicrm', 'packages/jquery/plugins/jstree/themes/default/style.css', 0, 'html-header')
126 ->addScriptFile('civicrm', 'templates/CRM/common/TabHeader.js', 1, 'html-header')
128 'summaryPrint' => array('mode' => $this->_print
),
129 'tabSettings' => array('active' => CRM_Utils_Request
::retrieve('selectedChild', 'String', $this, FALSE, 'summary')),
131 $this->assign('summaryPrint', $this->_print
);
132 $session = CRM_Core_Session
::singleton();
133 $url = CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $this->_contactId
);
134 $session->pushUserContext($url);
140 $params['id'] = $params['contact_id'] = $this->_contactId
;
141 $params['noRelationships'] = $params['noNotes'] = $params['noGroups'] = TRUE;
142 $contact = CRM_Contact_BAO_Contact
::retrieve($params, $defaults, TRUE);
144 $communicationType = array(
146 'type' => 'phoneType',
147 'id' => 'phone_type',
148 'daoName' => 'CRM_Core_DAO_Phone',
149 'fieldName' => 'phone_type_id',
152 'type' => 'IMProvider',
154 'daoName' => 'CRM_Core_DAO_IM',
155 'fieldName' => 'provider_id',
158 'type' => 'websiteType',
159 'id' => 'website_type',
160 'daoName' => 'CRM_Core_DAO_Website',
161 'fieldName' => 'website_type_id',
163 'address' => array('skip' => TRUE, 'customData' => 1),
164 'email' => array('skip' => TRUE),
165 'openid' => array('skip' => TRUE),
168 foreach ($communicationType as $key => $value) {
169 if (!empty($defaults[$key])) {
170 foreach ($defaults[$key] as & $val) {
171 CRM_Utils_Array
::lookupValue($val, 'location_type', CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id', array('labelColumn' => 'display_name')), FALSE);
172 if (empty($value['skip'])) {
173 $daoName = $value['daoName'];
174 $pseudoConst = $daoName::buildOptions($value['fieldName'], 'get');
175 CRM_Utils_Array
::lookupValue($val, $value['id'], $pseudoConst, FALSE);
178 if (isset($value['customData'])) {
179 foreach ($defaults[$key] as $blockId => $blockVal) {
180 $idValue = $blockVal['id'];
181 if ($key == 'address') {
182 if (!empty($blockVal['master_id'])) {
183 $idValue = $blockVal['master_id'];
186 $groupTree = CRM_Core_BAO_CustomGroup
::getTree(ucfirst($key),
190 // we setting the prefix to dnc_ below so that we don't overwrite smarty's grouptree var.
191 $defaults[$key][$blockId]['custom'] = CRM_Core_BAO_CustomGroup
::buildCustomDataView($this, $groupTree, FALSE, NULL, "dnc_");
193 // reset template variable since that won't be of any use, and could be misleading
194 $this->assign("dnc_viewCustomData", NULL);
199 if (!empty($defaults['gender_id'])) {
200 $defaults['gender_display'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'gender_id', $defaults['gender_id']);
203 $communicationStyle = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'communication_style_id');
204 if (!empty($communicationStyle)) {
205 if (!empty($defaults['communication_style_id'])) {
206 $defaults['communication_style_display'] = $communicationStyle[CRM_Utils_Array
::value('communication_style_id', $defaults)];
209 // Make sure the field is displayed as long as it is active, even if it is unset for this contact.
210 $defaults['communication_style_display'] = '';
214 // to make contact type label available in the template -
215 $contactType = array_key_exists('contact_sub_type', $defaults) ?
$defaults['contact_sub_type'] : $defaults['contact_type'];
216 $defaults['contact_type_label'] = CRM_Contact_BAO_ContactType
::contactTypePairs(TRUE, $contactType, ', ');
219 $contactTags = CRM_Core_BAO_EntityTag
::getContactTags($this->_contactId
);
221 if (!empty($contactTags)) {
222 $defaults['contactTag'] = implode(', ', $contactTags);
225 $defaults['privacy_values'] = CRM_Core_SelectValues
::privacy();
227 //Show blocks only if they are visible in edit form
228 $this->_editOptions
= CRM_Core_BAO_Setting
::valueOptions(
229 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
230 'contact_edit_options'
233 foreach ($this->_editOptions
as $blockName => $value) {
234 $varName = '_show' . $blockName;
235 $this->$varName = $value;
236 $this->assign(substr($varName, 1), $this->$varName);
239 // get contact name of shared contact names
240 $sharedAddresses = array();
241 $shareAddressContactNames = CRM_Contact_BAO_Contact_Utils
::getAddressShareContactNames($defaults['address']);
242 foreach ($defaults['address'] as $key => $addressValue) {
243 if (!empty($addressValue['master_id']) &&
244 !$shareAddressContactNames[$addressValue['master_id']]['is_deleted']
246 $sharedAddresses[$key]['shared_address_display'] = array(
247 'address' => $addressValue['display'],
248 'name' => $shareAddressContactNames[$addressValue['master_id']]['name'],
252 $this->assign('sharedAddresses', $sharedAddresses);
254 //get the current employer name
255 if (CRM_Utils_Array
::value('contact_type', $defaults) == 'Individual') {
256 if ($contact->employer_id
&& $contact->organization_name
) {
257 $defaults['current_employer'] = $contact->organization_name
;
258 $defaults['current_employer_id'] = $contact->employer_id
;
261 //for birthdate format with respect to birth format set
262 $this->assign('birthDateViewFormat', CRM_Utils_Array
::value('qfMapping', CRM_Utils_Date
::checkBirthDateFormat()));
265 $defaults['external_identifier'] = $contact->external_identifier
;
266 $this->assign($defaults);
268 // FIXME: when we sort out TZ isssues with DATETIME/TIMESTAMP, we can skip next query
269 // also assign the last modifed details
270 $lastModified = CRM_Core_BAO_Log
::lastModified($this->_contactId
, 'civicrm_contact');
271 $this->assign_by_ref('lastModified', $lastModified);
276 $this->_viewOptions
= CRM_Core_BAO_Setting
::valueOptions(
277 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
278 'contact_view_options',
282 // show the tabs only if user has generic access to CiviCRM
283 $accessCiviCRM = CRM_Core_Permission
::check('access CiviCRM');
285 $changeLog = $this->_viewOptions
['log'];
286 $this->assign_by_ref('changeLog', $changeLog);
287 $components = CRM_Core_Component
::getEnabledComponents();
289 foreach ($components as $name => $component) {
290 if (!empty($this->_viewOptions
[$name]) &&
291 CRM_Core_Permission
::access($component->name
)
293 $elem = $component->registerTab();
295 // FIXME: not very elegant, probably needs better approach
296 // allow explicit id, if not defined, use keyword instead
297 if (array_key_exists('id', $elem)) {
301 $i = $component->getKeyword();
305 //appending isTest to url for test soft credit CRM-3891.
306 //FIXME: hack ajax url.
307 $q = "reset=1&force=1&cid={$this->_contactId}";
308 if (CRM_Utils_Request
::retrieve('isTest', 'Positive', $this)) {
313 'url' => CRM_Utils_System
::url("civicrm/contact/view/$u", $q),
314 'title' => $elem['title'],
315 'weight' => $elem['weight'],
316 'count' => CRM_Contact_BAO_Contact
::getCountComponent($u, $this->_contactId
),
317 'class' => 'livePage',
319 // make sure to get maximum weight, rest of tabs go after
320 // FIXME: not very elegant again
321 if ($weight < $elem['weight']) {
322 $weight = $elem['weight'];
329 'title' => ts('Activities'),
330 'class' => 'livePage',
333 'title' => ts('Relationships'),
334 'class' => 'livePage',
337 'title' => ts('Groups'),
338 'class' => 'ajaxForm',
341 'title' => ts('Notes'),
342 'class' => 'livePage',
345 'title' => ts('Tags'),
348 'title' => ts('Change Log'),
352 foreach ($rest as $k => $v) {
353 if ($accessCiviCRM && !empty($this->_viewOptions
[$k])) {
354 $allTabs[] = $v +
array(
356 'url' => CRM_Utils_System
::url(
357 "civicrm/contact/view/$k",
358 "reset=1&cid={$this->_contactId}"
361 'count' => CRM_Contact_BAO_Contact
::getCountComponent($k, $this->_contactId
),
367 // now add all the custom tabs
368 $entityType = $this->get('contactType');
369 $activeGroups = CRM_Core_BAO_CustomGroup
::getActiveGroups(
371 'civicrm/contact/view/cd',
375 foreach ($activeGroups as $group) {
376 $id = "custom_{$group['id']}";
379 'url' => CRM_Utils_System
::url($group['path'], $group['query'] . "&selectedChild=$id"),
380 'title' => $group['title'],
382 'count' => CRM_Contact_BAO_Contact
::getCountComponent($id, $this->_contactId
, $group['table_name']),
383 'hideCount' => !$group['is_multiple'],
384 'class' => 'livePage',
389 // see if any other modules want to add any tabs
390 CRM_Utils_Hook
::tabs($allTabs, $this->_contactId
);
392 // now sort the tabs based on weight
393 usort($allTabs, array('CRM_Utils_Sort', 'cmpFunc'));
395 $this->assign('allTabs', $allTabs);
397 // hook for contact summary
398 // ignored but needed to prevent warnings
399 $contentPlacement = CRM_Utils_Hook
::SUMMARY_BELOW
;
400 CRM_Utils_Hook
::summary($this->_contactId
, $content, $contentPlacement);
402 $this->assign_by_ref('hookContent', $content);
403 $this->assign('hookContentPlacement', $contentPlacement);
410 public function getTemplateFileName() {
411 if ($this->_contactId
) {
412 $contactSubtypes = $this->get('contactSubtype') ?
explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $this->get('contactSubtype')) : array();
414 // there could be multiple subtypes. We check templates for each of the subtype, and return the first one found.
415 foreach ($contactSubtypes as $csType) {
417 $templateFile = "CRM/Contact/Page/View/SubType/{$csType}.tpl";
418 $template = CRM_Core_Page
::getTemplate();
419 if ($template->template_exists($templateFile)) {
420 return $templateFile;
425 return parent
::getTemplateFileName();