3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
35 * This class create activities for a case.
37 class CRM_Case_Form_Activity
extends CRM_Activity_Form_Activity
{
40 * The default variable defined.
47 * The default case type variable defined.
54 * The array of releted contact info.
58 public $_relatedContacts;
61 * Build the form object.
63 public function preProcess() {
64 $caseIds = CRM_Utils_Request
::retrieve('caseid', 'String', $this);
65 $this->_caseId
= explode(',', $caseIds);
66 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
67 if (!$this->_context
) {
68 $this->_context
= 'caseActivity';
70 $this->_crmDir
= 'Case';
71 $this->assign('context', $this->_context
);
73 $result = parent
::preProcess();
75 $scheduleStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Scheduled');
76 $this->assign('scheduleStatusId', $scheduleStatusId);
78 if (!$this->_caseId
&& $this->_activityId
) {
79 $this->_caseId
= CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseActivity', $this->_activityId
,
80 'case_id', 'activity_id'
84 $this->assign('caseId', $this->_caseId
);
85 $this->assign('countId', count($this->_caseId
));
86 $this->assign('caseID', CRM_Utils_Array
::first($this->_caseId
));
89 if (!$this->_caseId ||
90 (!$this->_activityId
&& !$this->_activityTypeId
)
92 CRM_Core_Error
::fatal('required params missing.');
95 //check for case activity access.
96 if (!CRM_Case_BAO_Case
::accessCiviCase()) {
97 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
100 if ($this->_caseId
&&
101 !CRM_Core_Permission
::check('access all cases and activities')
103 $params = array('type' => 'any');
104 $allCases = CRM_Case_BAO_Case
::getCases(TRUE, $params);
105 if (count(array_intersect($this->_caseId
, array_keys($allCases))) == 0) {
106 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
110 //validate case activity id.
111 if ($this->_activityId
&&
112 ($this->_action
& CRM_Core_Action
::UPDATE
)
114 $valid = CRM_Case_BAO_Case
::checkPermission($this->_activityId
, 'edit',
115 $this->_activityTypeId
118 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
122 foreach ($this->_caseId
as $casePos => $caseId) {
123 $this->_caseType
[$casePos] = CRM_Case_BAO_Case
::getCaseType($caseId, 'name');
125 $this->assign('caseType', $this->_caseType
);
127 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
128 $isMultiClient = $xmlProcessorProcess->getAllowMultipleCaseClients();
129 $this->assign('multiClient', $isMultiClient);
131 foreach ($this->_caseId
as $casePos => $caseId) {
132 $clients[] = CRM_Case_BAO_Case
::getContactNames($caseId);
134 $this->assign('client_names', $clients);
136 $caseIds = implode(',', $this->_caseId
);
137 // set context for pushUserContext and for statusBounce
138 if ($this->_context
== 'fulltext') {
139 if ($this->_action
== CRM_Core_Action
::UPDATE ||
$this->_action
== CRM_Core_Action
::DELETE
) {
140 $url = CRM_Utils_System
::url('civicrm/contact/view/case',
141 "reset=1&action=view&cid={$this->_currentlyViewedContactId}&id={$caseIds}&show=1&context={$this->_context}"
145 $url = CRM_Utils_System
::url('civicrm/contact/search/custom', 'force=1');
149 $url = CRM_Utils_System
::url('civicrm/contact/view/case',
150 "reset=1&action=view&cid={$this->_currentlyViewedContactId}&id={$caseIds}&show=1"
153 if (!$this->_activityId
) {
154 $caseTypes = CRM_Case_PseudoConstant
::caseType();
156 if (empty($caseTypes) && ($this->_activityTypeName
== 'Change Case Type') && !$this->_caseId
) {
157 $url = CRM_Utils_System
::url('civicrm/contact/view/case',
158 "reset=1&action=view&cid={$this->_currentlyViewedContactId}&id={$caseIds}&show=1"
160 $session = CRM_Core_Session
::singleton();
161 $session->pushUserContext($url);
162 CRM_Core_Error
::statusBounce(ts("You do not have any active Case Types"));
165 // check if activity count is within the limit
166 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
167 foreach ($this->_caseId
as $casePos => $caseId) {
168 $caseType = $this->_caseType
[$casePos];
169 $activityInst = $xmlProcessor->getMaxInstance($caseType);
171 // If not bounce back and also provide activity edit link
172 if (isset($activityInst[$this->_activityTypeName
])) {
173 $activityCount = CRM_Case_BAO_Case
::getCaseActivityCount($caseId, $this->_activityTypeId
);
174 if ($activityCount >= $activityInst[$this->_activityTypeName
]) {
175 if ($activityInst[$this->_activityTypeName
] == 1) {
176 $atArray = array('activity_type_id' => $this->_activityTypeId
);
177 $activities = CRM_Case_BAO_Case
::getCaseActivity($caseId,
179 $this->_currentUserId
181 $activities = array_keys($activities);
182 $activities = $activities[0];
183 $editUrl = CRM_Utils_System
::url('civicrm/case/activity',
184 "reset=1&cid={$this->_currentlyViewedContactId}&caseid={$caseId}&action=update&id={$activities}"
187 CRM_Core_Error
::statusBounce(ts("You can not add another '%1' activity to this case. %2",
189 1 => $this->_activityTypeName
,
190 2 => ts("Do you want to <a %1>edit the existing activity</a>?", array(1 => "href='$editUrl'")),
200 // Turn off the prompt which asks the user if they want to create separate
201 // activities when specifying multiple contacts "with" a new activity.
202 // Instead, always create one activity with all contacts together.
203 $this->supportsActivitySeparation
= FALSE;
205 $session = CRM_Core_Session
::singleton();
206 $session->pushUserContext($url);
210 * Set default values for the form.
212 public function setDefaultValues() {
213 $this->_defaults
= parent
::setDefaultValues();
214 $targetContactValues = array();
215 foreach ($this->_caseId
as $key => $val) {
217 $clients = CRM_Case_BAO_Case
::getContactNames($val);
218 if (isset($this->_activityId
) && empty($_POST)) {
219 if (!CRM_Utils_Array
::crmIsEmptyArray($this->_defaults
['target_contact'])) {
220 $targetContactValues = array_combine(array_unique($this->_defaults
['target_contact']),
221 explode(';', trim($this->_defaults
['target_contact_value']))
223 //exclude all clients.
224 foreach ($clients as $clientId => $vals) {
225 if (array_key_exists($clientId, $targetContactValues)) {
226 unset($targetContactValues[$clientId]);
231 $this->assign('targetContactValues', empty($targetContactValues) ?
FALSE : $targetContactValues);
233 if (isset($this->_encounterMedium
)) {
234 $this->_defaults
['medium_id'] = $this->_encounterMedium
;
236 elseif (empty($this->_defaults
['medium_id'])) {
237 // set default encounter medium CRM-4816
238 $medium = CRM_Core_OptionGroup
::values('encounter_medium', FALSE, FALSE, FALSE, 'AND is_default = 1');
239 if (count($medium) == 1) {
240 $this->_defaults
['medium_id'] = key($medium);
244 return $this->_defaults
;
248 public function buildQuickForm() {
249 $this->_fields
['source_contact_id']['label'] = ts('Reported By');
250 unset($this->_fields
['status_id']['attributes']['required']);
252 if ($this->_caseType
) {
253 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
255 foreach ($this->_caseType
as $key => $val) {
256 $activityTypes = $xmlProcessor->get($val, 'ActivityTypes', TRUE);
257 $aTypes = $aTypes +
$activityTypes;
260 // remove Open Case activity type since we're inside an existing case
261 $openCaseID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Open Case');
262 unset($aTypes[$openCaseID]);
264 $this->_fields
['followup_activity_type_id']['attributes'] = array('' => '- select activity type -') +
$aTypes;
267 parent
::buildQuickForm();
269 if ($this->_action
& (CRM_Core_Action
::DELETE | CRM_Core_Action
::DETACH | CRM_Core_Action
::RENEW
)) {
273 $this->assign('urlPath', 'civicrm/case/activity');
275 $encounterMediums = CRM_Case_PseudoConstant
::encounterMedium();
276 // Fixme: what's the justification for this? It seems like it is just re-adding an option in case it is the default and disabled.
277 // Is that really a big problem?
278 if ($this->_activityTypeFile
== 'OpenCase') {
279 $this->_encounterMedium
= CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $this->_activityId
,
282 if (!array_key_exists($this->_encounterMedium
, $encounterMediums)) {
283 $encounterMediums[$this->_encounterMedium
] = CRM_Core_OptionGroup
::getLabel('encounter_medium',
284 $this->_encounterMedium
,
290 $this->add('select', 'medium_id', ts('Medium'), $encounterMediums, TRUE);
292 foreach ($this->_caseId
as $key => $val) {
293 $this->_relatedContacts
[] = $rgc = CRM_Case_BAO_Case
::getRelatedAndGlobalContacts($val);
294 $contName = CRM_Case_BAO_Case
::getContactNames($val);
295 foreach ($contName as $nkey => $nval) {
296 array_push($this->_relatedContacts
[$i][0], $this->_relatedContacts
[$i][0]['managerOf'] = $nval['display_name']);
301 //add case client in send a copy selector.CRM-4438.
302 foreach ($this->_caseId
as $key => $val) {
303 $relatedContacts[] = $relCon = CRM_Case_BAO_Case
::getContactNames($val);
306 if (!empty($relatedContacts)) {
307 foreach ($relatedContacts as $relatedContact) {
308 $this->_relatedContacts
[] = $relatedContact;
312 if (!empty($this->_relatedContacts
)) {
313 $checkBoxes = array();
314 foreach ($this->_relatedContacts
as $id => $row) {
315 foreach ($row as $key => $value) {
316 $checkBoxes[$key] = $this->addElement('checkbox', $key, NULL, NULL, array('class' => 'select-row'));
320 $this->addGroup($checkBoxes, 'contact_check');
321 $this->addElement('checkbox', 'toggleSelect', NULL, NULL,
322 array('class' => 'select-rows')
324 $this->assign('searchRows', $this->_relatedContacts
);
326 $this->_relatedContacts
= $rgc +
$relCon;
328 $this->addFormRule(array('CRM_Case_Form_Activity', 'formRule'), $this);
334 * @param array $fields
335 * The input form values.
336 * @param array $files
337 * The uploaded files if any.
341 * true if no errors, else array of errors
343 public static function formRule($fields, $files, $self) {
344 // skip form rule if deleting
345 if (CRM_Utils_Array
::value('_qf_Activity_next_', $fields) == 'Delete' || CRM_Utils_Array
::value('_qf_Activity_next_', $fields) == 'Restore') {
349 return parent
::formRule($fields, $files, $self);
353 * Process the form submission.
355 * @param array $params
357 public function postProcess($params = NULL) {
358 $transaction = new CRM_Core_Transaction();
360 if ($this->_action
& CRM_Core_Action
::DELETE
) {
363 //block deleting activities which affects
364 //case attributes.CRM-4543
365 $activityCondition = " AND v.name IN ('Open Case', 'Change Case Type', 'Change Case Status', 'Change Case Start Date')";
366 $caseAttributeActivities = CRM_Core_OptionGroup
::values('activity_type', FALSE, FALSE, FALSE, $activityCondition);
368 if (!array_key_exists($this->_activityTypeId
, $caseAttributeActivities)) {
369 $params = array('id' => $this->_activityId
);
370 $activityDelete = CRM_Activity_BAO_Activity
::deleteActivity($params, TRUE);
371 if ($activityDelete) {
372 $statusMsg = ts('The selected activity has been moved to the Trash. You can view and / or restore deleted activities by checking "Deleted Activities" from the Case Activities search filter (under Manage Case).<br />');
376 $statusMsg = ts("Selected Activity cannot be deleted.");
380 'entity_table' => 'civicrm_activity',
381 'entity_id' => $this->_activityId
,
383 CRM_Core_BAO_EntityTag
::del($tagParams);
385 CRM_Core_Session
::setStatus('', $statusMsg, 'info');
389 if ($this->_action
& CRM_Core_Action
::RENEW
) {
391 $params = array('id' => $this->_activityId
);
392 $activityRestore = CRM_Activity_BAO_Activity
::restoreActivity($params);
393 if ($activityRestore) {
394 $statusMsg = ts('The selected activity has been restored.<br />');
396 CRM_Core_Session
::setStatus('', $statusMsg, 'info');
400 // store the submitted values in an array
401 $params = $this->controller
->exportValues($this->_name
);
403 //set parent id if its edit mode
404 if ($parentId = CRM_Utils_Array
::value('parent_id', $this->_defaults
)) {
405 $params['parent_id'] = $parentId;
408 // store the dates with proper format
409 $params['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
410 $params['activity_type_id'] = $this->_activityTypeId
;
412 // format with contact (target contact) values
413 if (isset($params['target_contact_id'])) {
414 $params['target_contact_id'] = explode(',', $params['target_contact_id']);
417 $params['target_contact_id'] = array();
420 // format activity custom data
421 if (!empty($params['hidden_custom'])) {
422 if ($this->_activityId
) {
423 // retrieve and include the custom data of old Activity
424 $oldActivity = civicrm_api3('Activity', 'getsingle', array('id' => $this->_activityId
));
425 $params = array_merge($oldActivity, $params);
427 // unset custom fields-id from params since we want custom
428 // fields to be saved for new activity.
429 foreach ($params as $key => $value) {
431 if (preg_match('/^(custom_\d+_)(\d+)$/', $key, $match)) {
432 $params[$match[1] . '-1'] = $params[$key];
434 // for autocomplete transfer hidden value instead of label
435 if ($params[$key] && isset($params[$key . '_id'])) {
436 $params[$match[1] . '-1_id'] = $params[$key . '_id'];
437 unset($params[$key . '_id']);
439 unset($params[$key]);
444 // build custom data getFields array
445 $customFields = CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE, $this->_activityTypeId
);
446 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
447 CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE,
451 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
457 // assigning formatted value
458 if (!empty($params['assignee_contact_id'])) {
459 $params['assignee_contact_id'] = explode(',', $params['assignee_contact_id']);
462 $params['assignee_contact_id'] = array();
465 if (isset($this->_activityId
)) {
466 // activity which hasn't been modified by a user yet
467 if ($this->_defaults
['is_auto'] == 1) {
468 $params['is_auto'] = 0;
471 // always create a revision of an case activity. CRM-4533
472 $newActParams = $params;
474 // add target contact values in update mode
475 if (empty($params['target_contact_id']) && !empty($this->_defaults
['target_contact'])) {
476 $newActParams['target_contact_id'] = $this->_defaults
['target_contact'];
480 if (!isset($newActParams)) {
481 // add more attachments if needed for old activity
482 CRM_Core_BAO_File
::formatAttachment($params,
487 // call begin post process, before the activity is created/updated.
488 $this->beginPostProcess($params);
489 foreach ($this->_caseId
as $key => $val) {
490 $params['case_id'] = $val;
491 // activity create/update
492 $activity = CRM_Activity_BAO_Activity
::create($params);
493 $vvalue[] = array('case_id' => $val, 'actId' => $activity->id
);
494 // call end post process, after the activity has been created/updated.
495 $this->endPostProcess($params, $activity);
499 // since the params we need to set are very few, and we don't want rest of the
500 // work done by bao create method , lets use dao object to make the changes
501 $params = array('id' => $this->_activityId
);
502 $params['is_current_revision'] = 0;
503 $activity = new CRM_Activity_DAO_Activity();
504 $activity->copyValues($params);
508 // create a new version of activity if activity was found to
509 // have been modified/created by user
510 if (isset($newActParams)) {
511 // set proper original_id
512 if (!empty($this->_defaults
['original_id'])) {
513 $newActParams['original_id'] = $this->_defaults
['original_id'];
516 $newActParams['original_id'] = $activity->id
;
519 //is_current_revision will be set to 1 by default.
520 // add attachments if any
521 CRM_Core_BAO_File
::formatAttachment($newActParams,
526 // call begin post process, before the activity is created/updated.
527 $this->beginPostProcess($newActParams);
528 foreach ($this->_caseId
as $key => $val) {
529 $newActParams['case_id'] = $val;
530 $activity = CRM_Activity_BAO_Activity
::create($newActParams);
531 $vvalue[] = array('case_id' => $val, 'actId' => $activity->id
);
532 // call end post process, after the activity has been created/updated.
533 $this->endPostProcess($newActParams, $activity);
535 // copy files attached to old activity if any, to new one,
536 // as long as users have not selected the 'delete attachment' option.
537 if (empty($newActParams['is_delete_attachment'])) {
538 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $this->_activityId
,
539 'civicrm_activity', $activity->id
543 // copy back params to original var
544 $params = $newActParams;
547 foreach ($vvalue as $vkey => $vval) {
548 if ($vval['actId']) {
549 // add tags if exists
550 $tagParams = array();
551 if (!empty($params['tag'])) {
552 foreach ($params['tag'] as $tag) {
553 $tagParams[$tag] = 1;
558 CRM_Core_BAO_EntityTag
::create($tagParams, 'civicrm_activity', $vval['actId']);
561 if (isset($params['taglist']) && !empty($params['taglist'])) {
562 CRM_Core_Form_Tag
::postProcess($params['taglist'], $vval['actId'], 'civicrm_activity', $this);
566 // update existing case record if needed
567 $caseParams = $params;
568 $caseParams['id'] = $vval['case_id'];
569 if (!empty($caseParams['case_status_id'])) {
570 $caseParams['status_id'] = $caseParams['case_status_id'];
573 // unset params intended for activities only
574 unset($caseParams['subject'], $caseParams['details'],
575 $caseParams['status_id'], $caseParams['custom']
577 $case = CRM_Case_BAO_Case
::create($caseParams);
578 // create case activity record
580 'activity_id' => $vval['actId'],
581 'case_id' => $vval['case_id'],
583 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
586 // Insert civicrm_log record for the activity (e.g. store the
587 // created / edited by contact id and date for the activity)
588 // Note - civicrm_log is already created by CRM_Activity_BAO_Activity::create()
590 // send copy to selected contacts.
592 $mailToContacts = array();
595 //check for notification settings for assignee contacts
596 $selectedContacts = array('contact_check');
597 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
598 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
599 if (Civi
::settings()->get('activity_assignee_notification')) {
600 $selectedContacts[] = 'assignee_contact_id';
603 foreach ($vvalue as $vkey => $vval) {
604 foreach ($selectedContacts as $dnt => $val) {
605 if (array_key_exists($val, $params) && !CRM_Utils_Array
::crmIsEmptyArray($params[$val])) {
606 if ($val == 'contact_check') {
607 $mailStatus = ts("A copy of the activity has also been sent to selected contacts(s).");
610 $this->_relatedContacts
= CRM_Activity_BAO_ActivityAssignment
::getAssigneeNames(array($vval['actId']), TRUE, FALSE);
611 $mailStatus .= ' ' . ts("A copy of the activity has also been sent to assignee contacts(s).");
613 //build an associative array with unique email addresses.
614 foreach ($params[$val] as $key => $value) {
615 if ($val == 'contact_check') {
622 if (isset($id) && array_key_exists($id, $this->_relatedContacts
) && isset($this->_relatedContacts
[$id]['email'])) {
623 //if email already exists in array then append with ', ' another role only otherwise add it to array.
624 if ($contactDetails = CRM_Utils_Array
::value($this->_relatedContacts
[$id]['email'], $mailToContacts)) {
625 $caseRole = CRM_Utils_Array
::value('role', $this->_relatedContacts
[$id]);
626 $mailToContacts[$this->_relatedContacts
[$id]['email']]['role'] = $contactDetails['role'] . ', ' . $caseRole;
629 $mailToContacts[$this->_relatedContacts
[$id]['email']] = $this->_relatedContacts
[$id];
636 $extraParams = array('case_id' => $vval['case_id'], 'client_id' => $this->_currentlyViewedContactId
);
637 $result = CRM_Activity_BAO_Activity
::sendToAssignee($activity, $mailToContacts, $extraParams);
638 if (empty($result)) {
642 // create follow up activity if needed
643 $followupStatus = '';
644 if (!empty($params['followup_activity_type_id'])) {
645 $followupActivity = CRM_Activity_BAO_Activity
::createFollowupActivity($vval['actId'], $params);
647 if ($followupActivity) {
649 'activity_id' => $followupActivity->id
,
650 'case_id' => $vval['case_id'],
652 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
653 $followupStatus = ts("A followup activity has been scheduled.") . '<br /><br />';
656 $title = ts("%1 Saved", array(1 => $this->_activityTypeName
));
657 CRM_Core_Session
::setStatus($followupStatus . $mailStatus, $title, 'success');