3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
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_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
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 $session = CRM_Core_Session
::singleton();
104 $allCases = CRM_Case_BAO_Case
::getCases(TRUE, $session->get('userID'), 'any');
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 $session = CRM_Core_Session
::singleton();
201 $session->pushUserContext($url);
205 * Set default values for the form.
207 public function setDefaultValues() {
208 $this->_defaults
= parent
::setDefaultValues();
209 $targetContactValues = array();
210 foreach ($this->_caseId
as $key => $val) {
212 $clients = CRM_Case_BAO_Case
::getContactNames($val);
213 if (isset($this->_activityId
) && empty($_POST)) {
214 if (!CRM_Utils_Array
::crmIsEmptyArray($this->_defaults
['target_contact'])) {
215 $targetContactValues = array_combine(array_unique($this->_defaults
['target_contact']),
216 explode(';', trim($this->_defaults
['target_contact_value']))
218 //exclude all clients.
219 foreach ($clients as $clientId => $vals) {
220 if (array_key_exists($clientId, $targetContactValues)) {
221 unset($targetContactValues[$clientId]);
226 $this->assign('targetContactValues', empty($targetContactValues) ?
FALSE : $targetContactValues);
228 if (isset($this->_encounterMedium
)) {
229 $this->_defaults
['medium_id'] = $this->_encounterMedium
;
231 elseif (empty($this->_defaults
['medium_id'])) {
232 // set default encounter medium CRM-4816
233 $medium = CRM_Core_OptionGroup
::values('encounter_medium', FALSE, FALSE, FALSE, 'AND is_default = 1');
234 if (count($medium) == 1) {
235 $this->_defaults
['medium_id'] = key($medium);
239 return $this->_defaults
;
243 public function buildQuickForm() {
244 $this->_fields
['source_contact_id']['label'] = ts('Reported By');
245 unset($this->_fields
['status_id']['attributes']['required']);
247 if ($this->_caseType
) {
248 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
250 foreach ($this->_caseType
as $key => $val) {
251 $activityTypes = $xmlProcessor->get($val, 'ActivityTypes', TRUE);
252 $aTypes = $aTypes +
$activityTypes;
255 // remove Open Case activity type since we're inside an existing case
256 $openCaseID = CRM_Core_OptionGroup
::getValue('activity_type', 'Open Case', 'name');
257 unset($aTypes[$openCaseID]);
259 $this->_fields
['followup_activity_type_id']['attributes'] = array('' => '- select activity type -') +
$aTypes;
262 parent
::buildQuickForm();
264 if ($this->_action
& (CRM_Core_Action
::DELETE | CRM_Core_Action
::DETACH | CRM_Core_Action
::RENEW
)) {
268 $this->assign('urlPath', 'civicrm/case/activity');
270 $encounterMediums = CRM_Case_PseudoConstant
::encounterMedium();
271 // 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.
272 // Is that really a big problem?
273 if ($this->_activityTypeFile
== 'OpenCase') {
274 $this->_encounterMedium
= CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $this->_activityId
,
277 if (!array_key_exists($this->_encounterMedium
, $encounterMediums)) {
278 $encounterMediums[$this->_encounterMedium
] = CRM_Core_OptionGroup
::getLabel('encounter_medium',
279 $this->_encounterMedium
,
285 $this->add('select', 'medium_id', ts('Medium'), $encounterMediums, TRUE);
287 foreach ($this->_caseId
as $key => $val) {
288 $this->_relatedContacts
[] = $rgc = CRM_Case_BAO_Case
::getRelatedAndGlobalContacts($val);
289 $contName = CRM_Case_BAO_Case
::getContactNames($val);
290 foreach ($contName as $nkey => $nval) {
291 array_push($this->_relatedContacts
[$i][0], $this->_relatedContacts
[$i][0]['managerOf'] = $nval['display_name']);
296 //add case client in send a copy selector.CRM-4438.
297 foreach ($this->_caseId
as $key => $val) {
298 $relatedContacts[] = $relCon = CRM_Case_BAO_Case
::getContactNames($val);
301 if (!empty($relatedContacts)) {
302 foreach ($relatedContacts as $relatedContact) {
303 $this->_relatedContacts
[] = $relatedContact;
307 if (!empty($this->_relatedContacts
)) {
308 $checkBoxes = array();
309 foreach ($this->_relatedContacts
as $id => $row) {
310 foreach ($row as $key => $value) {
311 $checkBoxes[$key] = $this->addElement('checkbox', $key, NULL, NULL, array('class' => 'select-row'));
315 $this->addGroup($checkBoxes, 'contact_check');
316 $this->addElement('checkbox', 'toggleSelect', NULL, NULL,
317 array('class' => 'select-rows')
319 $this->assign('searchRows', $this->_relatedContacts
);
321 $this->_relatedContacts
= $rgc +
$relCon;
323 $this->addFormRule(array('CRM_Case_Form_Activity', 'formRule'), $this);
329 * @param array $fields
330 * The input form values.
331 * @param array $files
332 * The uploaded files if any.
336 * true if no errors, else array of errors
338 public static function formRule($fields, $files, $self) {
339 // skip form rule if deleting
340 if (CRM_Utils_Array
::value('_qf_Activity_next_', $fields) == 'Delete' || CRM_Utils_Array
::value('_qf_Activity_next_', $fields) == 'Restore') {
344 return parent
::formRule($fields, $files, $self);
348 * Process the form submission.
350 * @param array $params
352 public function postProcess($params = NULL) {
353 $transaction = new CRM_Core_Transaction();
355 if ($this->_action
& CRM_Core_Action
::DELETE
) {
358 //block deleting activities which affects
359 //case attributes.CRM-4543
360 $activityCondition = " AND v.name IN ('Open Case', 'Change Case Type', 'Change Case Status', 'Change Case Start Date')";
361 $caseAttributeActivities = CRM_Core_OptionGroup
::values('activity_type', FALSE, FALSE, FALSE, $activityCondition);
363 if (!array_key_exists($this->_activityTypeId
, $caseAttributeActivities)) {
364 $params = array('id' => $this->_activityId
);
365 $activityDelete = CRM_Activity_BAO_Activity
::deleteActivity($params, TRUE);
366 if ($activityDelete) {
367 $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 />');
371 $statusMsg = ts("Selected Activity cannot be deleted.");
375 'entity_table' => 'civicrm_activity',
376 'entity_id' => $this->_activityId
,
378 CRM_Core_BAO_EntityTag
::del($tagParams);
380 CRM_Core_Session
::setStatus('', $statusMsg, 'info');
384 if ($this->_action
& CRM_Core_Action
::RENEW
) {
386 $params = array('id' => $this->_activityId
);
387 $activityRestore = CRM_Activity_BAO_Activity
::restoreActivity($params);
388 if ($activityRestore) {
389 $statusMsg = ts('The selected activity has been restored.<br />');
391 CRM_Core_Session
::setStatus('', $statusMsg, 'info');
395 // store the submitted values in an array
396 $params = $this->controller
->exportValues($this->_name
);
398 //set parent id if its edit mode
399 if ($parentId = CRM_Utils_Array
::value('parent_id', $this->_defaults
)) {
400 $params['parent_id'] = $parentId;
403 // store the dates with proper format
404 $params['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
405 $params['activity_type_id'] = $this->_activityTypeId
;
407 // format with contact (target contact) values
408 if (isset($params['target_contact_id'])) {
409 $params['target_contact_id'] = explode(',', $params['target_contact_id']);
412 $params['target_contact_id'] = array();
415 // format activity custom data
416 if (!empty($params['hidden_custom'])) {
417 if ($this->_activityId
) {
418 // retrieve and include the custom data of old Activity
419 $oldActivity = civicrm_api3('Activity', 'getsingle', array('id' => $this->_activityId
));
420 $params = array_merge($oldActivity, $params);
422 // unset custom fields-id from params since we want custom
423 // fields to be saved for new activity.
424 foreach ($params as $key => $value) {
426 if (preg_match('/^(custom_\d+_)(\d+)$/', $key, $match)) {
427 $params[$match[1] . '-1'] = $params[$key];
429 // for autocomplete transfer hidden value instead of label
430 if ($params[$key] && isset($params[$key . '_id'])) {
431 $params[$match[1] . '-1_id'] = $params[$key . '_id'];
432 unset($params[$key . '_id']);
434 unset($params[$key]);
439 // build custom data getFields array
440 $customFields = CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE, $this->_activityTypeId
);
441 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
442 CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE,
446 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
452 // assigning formatted value
453 if (!empty($params['assignee_contact_id'])) {
454 $params['assignee_contact_id'] = explode(',', $params['assignee_contact_id']);
457 $params['assignee_contact_id'] = array();
460 if (isset($this->_activityId
)) {
461 // activity which hasn't been modified by a user yet
462 if ($this->_defaults
['is_auto'] == 1) {
463 $params['is_auto'] = 0;
466 // always create a revision of an case activity. CRM-4533
467 $newActParams = $params;
469 // add target contact values in update mode
470 if (empty($params['target_contact_id']) && !empty($this->_defaults
['target_contact'])) {
471 $newActParams['target_contact_id'] = $this->_defaults
['target_contact'];
475 if (!isset($newActParams)) {
476 // add more attachments if needed for old activity
477 CRM_Core_BAO_File
::formatAttachment($params,
482 // call begin post process, before the activity is created/updated.
483 $this->beginPostProcess($params);
484 foreach ($this->_caseId
as $key => $val) {
485 $params['case_id'] = $val;
486 // activity create/update
487 $activity = CRM_Activity_BAO_Activity
::create($params);
488 $vvalue[] = array('case_id' => $val, 'actId' => $activity->id
);
489 // call end post process, after the activity has been created/updated.
490 $this->endPostProcess($params, $activity);
494 // since the params we need to set are very few, and we don't want rest of the
495 // work done by bao create method , lets use dao object to make the changes
496 $params = array('id' => $this->_activityId
);
497 $params['is_current_revision'] = 0;
498 $activity = new CRM_Activity_DAO_Activity();
499 $activity->copyValues($params);
503 // create a new version of activity if activity was found to
504 // have been modified/created by user
505 if (isset($newActParams)) {
506 // set proper original_id
507 if (!empty($this->_defaults
['original_id'])) {
508 $newActParams['original_id'] = $this->_defaults
['original_id'];
511 $newActParams['original_id'] = $activity->id
;
514 //is_current_revision will be set to 1 by default.
515 // add attachments if any
516 CRM_Core_BAO_File
::formatAttachment($newActParams,
521 // call begin post process, before the activity is created/updated.
522 $this->beginPostProcess($newActParams);
523 foreach ($this->_caseId
as $key => $val) {
524 $newActParams['case_id'] = $val;
525 $activity = CRM_Activity_BAO_Activity
::create($newActParams);
526 $vvalue[] = array('case_id' => $val, 'actId' => $activity->id
);
527 // call end post process, after the activity has been created/updated.
528 $this->endPostProcess($newActParams, $activity);
530 // copy files attached to old activity if any, to new one,
531 // as long as users have not selected the 'delete attachment' option.
532 if (empty($newActParams['is_delete_attachment'])) {
533 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $this->_activityId
,
534 'civicrm_activity', $activity->id
538 // copy back params to original var
539 $params = $newActParams;
542 foreach ($vvalue as $vkey => $vval) {
543 if ($vval['actId']) {
544 // add tags if exists
545 $tagParams = array();
546 if (!empty($params['tag'])) {
547 foreach ($params['tag'] as $tag) {
548 $tagParams[$tag] = 1;
553 CRM_Core_BAO_EntityTag
::create($tagParams, 'civicrm_activity', $vval['actId']);
556 if (isset($params['taglist']) && !empty($params['taglist'])) {
557 CRM_Core_Form_Tag
::postProcess($params['taglist'], $vval['actId'], 'civicrm_activity', $this);
561 // update existing case record if needed
562 $caseParams = $params;
563 $caseParams['id'] = $vval['case_id'];
564 if (!empty($caseParams['case_status_id'])) {
565 $caseParams['status_id'] = $caseParams['case_status_id'];
568 // unset params intended for activities only
569 unset($caseParams['subject'], $caseParams['details'],
570 $caseParams['status_id'], $caseParams['custom']
572 $case = CRM_Case_BAO_Case
::create($caseParams);
573 // create case activity record
575 'activity_id' => $vval['actId'],
576 'case_id' => $vval['case_id'],
578 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
581 // Insert civicrm_log record for the activity (e.g. store the
582 // created / edited by contact id and date for the activity)
583 // Note - civicrm_log is already created by CRM_Activity_BAO_Activity::create()
585 // send copy to selected contacts.
587 $mailToContacts = array();
590 //check for notification settings for assignee contacts
591 $selectedContacts = array('contact_check');
592 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
593 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
594 if (Civi
::settings()->get('activity_assignee_notification')) {
595 $selectedContacts[] = 'assignee_contact_id';
598 foreach ($vvalue as $vkey => $vval) {
599 foreach ($selectedContacts as $dnt => $val) {
600 if (array_key_exists($val, $params) && !CRM_Utils_Array
::crmIsEmptyArray($params[$val])) {
601 if ($val == 'contact_check') {
602 $mailStatus = ts("A copy of the activity has also been sent to selected contacts(s).");
605 $this->_relatedContacts
= CRM_Activity_BAO_ActivityAssignment
::getAssigneeNames(array($vval['actId']), TRUE, FALSE);
606 $mailStatus .= ' ' . ts("A copy of the activity has also been sent to assignee contacts(s).");
608 //build an associative array with unique email addresses.
609 foreach ($params[$val] as $key => $value) {
610 if ($val == 'contact_check') {
617 if (isset($id) && array_key_exists($id, $this->_relatedContacts
) && isset($this->_relatedContacts
[$id]['email'])) {
618 //if email already exists in array then append with ', ' another role only otherwise add it to array.
619 if ($contactDetails = CRM_Utils_Array
::value($this->_relatedContacts
[$id]['email'], $mailToContacts)) {
620 $caseRole = CRM_Utils_Array
::value('role', $this->_relatedContacts
[$id]);
621 $mailToContacts[$this->_relatedContacts
[$id]['email']]['role'] = $contactDetails['role'] . ', ' . $caseRole;
624 $mailToContacts[$this->_relatedContacts
[$id]['email']] = $this->_relatedContacts
[$id];
631 $extraParams = array('case_id' => $vval['case_id'], 'client_id' => $this->_currentlyViewedContactId
);
632 $result = CRM_Activity_BAO_Activity
::sendToAssignee($activity, $mailToContacts, $extraParams);
633 if (empty($result)) {
637 // create follow up activity if needed
638 $followupStatus = '';
639 if (!empty($params['followup_activity_type_id'])) {
640 $followupActivity = CRM_Activity_BAO_Activity
::createFollowupActivity($vval['actId'], $params);
642 if ($followupActivity) {
644 'activity_id' => $followupActivity->id
,
645 'case_id' => $vval['case_id'],
647 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
648 $followupStatus = ts("A followup activity has been scheduled.") . '<br /><br />';
651 $title = ts("%1 Saved", array(1 => $this->_activityTypeName
));
652 CRM_Core_Session
::setStatus($followupStatus . $mailStatus, $title, 'success');