3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * This class generates form components for OpenCase Activity.
37 class CRM_Case_Form_Activity_ChangeCaseStartDate
{
40 * @param CRM_Core_Form $form
44 public static function preProcess(&$form) {
45 if (!isset($form->_caseId
)) {
46 CRM_Core_Error
::fatal(ts('Case Id not found.'));
48 if (count($form->_caseId
) != 1) {
49 CRM_Core_Resources
::fatal(ts('Expected one case-type'));
54 * Set default values for the form.
56 * For edit/view mode the default values are retrieved from the database.
58 * @param CRM_Core_Form $form
62 public static function setDefaultValues(&$form) {
65 $openCaseActivityType = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Open Case');
66 $caseId = CRM_Utils_Array
::first($form->_caseId
);
67 $openCaseParams = ['activity_type_id' => $openCaseActivityType];
68 $openCaseInfo = CRM_Case_BAO_Case
::getCaseActivityDates($caseId, $openCaseParams, TRUE);
69 if (empty($openCaseInfo)) {
70 $defaults['start_date'] = date('Y-m-d H:i:s');
73 // We know there can only be one result
74 $openCaseInfo = current($openCaseInfo);
76 // store activity id for updating it later
77 $form->openCaseActivityId
= $openCaseInfo['id'];
79 $defaults['start_date'] = $openCaseInfo['activity_date'];
85 * @param CRM_Core_Form $form
87 public static function buildQuickForm(&$form) {
88 $form->removeElement('status_id');
89 $form->removeElement('priority_id');
90 $caseId = CRM_Utils_Array
::first($form->_caseId
);
92 $currentStartDate = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case', $caseId, 'start_date');
93 $form->assign('current_start_date', $currentStartDate);
94 $form->add('datepicker', 'start_date', ts('New Start Date'), [], TRUE);
98 * Global validation rules for the form.
100 * @param array $values
101 * Posted values of the form.
104 * @param CRM_Core_Form $form
107 * list of errors to be posted back to the form
109 public static function formRule($values, $files, $form) {
114 * Process the form submission.
117 * @param CRM_Core_Form $form
118 * @param array $params
120 public static function beginPostProcess(&$form, &$params) {
121 if ($form->_context
== 'case') {
122 $params['id'] = $form->_id
;
127 * Process the form submission.
130 * @param CRM_Core_Form $form
131 * @param array $params
134 public static function endPostProcess(&$form, &$params, $activity) {
135 $caseType = CRM_Utils_Array
::first($form->_caseType
);
136 $caseId = CRM_Utils_Array
::first($form->_caseId
);
138 if (!$caseType && $caseId) {
139 $caseType = CRM_Case_BAO_Case
::getCaseType($caseId, 'title');
142 if (!$form->_currentlyViewedContactId ||
143 !$form->_currentUserId ||
147 CRM_Core_Error
::fatal('Required parameter missing for ChangeCaseType - end post processing');
150 $config = CRM_Core_Config
::singleton();
152 $params['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
153 $activity->status_id
= $params['status_id'];
154 $params['priority_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Normal');
155 $activity->priority_id
= $params['priority_id'];
157 // 1. save activity subject with new start date
158 $currentStartDate = CRM_Utils_Date
::customFormat(CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case',
159 $caseId, 'start_date'
160 ), $config->dateformatFull
);
161 $newStartDate = CRM_Utils_Date
::customFormat($params['start_date'], $config->dateformatFull
);
162 $subject = 'Change Case Start Date from ' . $currentStartDate . ' to ' . $newStartDate;
163 $activity->subject
= $subject;
165 // 2. initiate xml processor
166 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
167 $xmlProcessorParams = [
168 'clientID' => $form->_currentlyViewedContactId
,
169 'creatorID' => $form->_currentUserId
,
170 'standardTimeline' => 0,
171 'activity_date_time' => $params['start_date'],
173 'caseType' => $caseType,
174 'activityTypeName' => 'Change Case Start Date',
175 'activitySetName' => 'standard_timeline',
176 'resetTimeline' => 1,
179 $xmlProcessor->run($caseType, $xmlProcessorParams);
181 // 2.5 Update open case activity date
182 // Multiple steps since revisioned
183 if ($form->openCaseActivityId
) {
185 $abao = new CRM_Activity_BAO_Activity();
186 $oldParams = ['id' => $form->openCaseActivityId
];
187 $oldActivityDefaults = [];
188 $oldActivity = $abao->retrieve($oldParams, $oldActivityDefaults);
190 // save the old values
191 require_once 'api/v3/utils.php';
192 $openCaseParams = [];
193 //@todo calling api functions directly is not supported
194 _civicrm_api3_object_to_array($oldActivity, $openCaseParams);
196 // update existing revision
198 'id' => $form->openCaseActivityId
,
199 'is_current_revision' => 0,
201 $oldActivity = new CRM_Activity_DAO_Activity();
202 $oldActivity->copyValues($oldParams);
203 $oldActivity->save();
205 // change some params for the new one
206 unset($openCaseParams['id']);
207 $openCaseParams['activity_date_time'] = $params['start_date'];
208 $openCaseParams['target_contact_id'] = $oldActivityDefaults['target_contact'];
209 $openCaseParams['assignee_contact_id'] = $oldActivityDefaults['assignee_contact'];
210 $session = CRM_Core_Session
::singleton();
211 $openCaseParams['source_contact_id'] = $session->get('userID');
213 // original_id always refers to the first activity, so only update if null (i.e. this is the second revision)
214 $openCaseParams['original_id'] = $openCaseParams['original_id'] ?
$openCaseParams['original_id'] : $form->openCaseActivityId
;
216 $newActivity = CRM_Activity_BAO_Activity
::create($openCaseParams);
217 if (is_a($newActivity, 'CRM_Core_Error')) {
218 CRM_Core_Error
::fatal('Unable to update Open Case activity');
221 // Create linkage to case
222 $caseActivityParams = [
223 'activity_id' => $newActivity->id
,
224 'case_id' => $caseId,
227 CRM_Case_BAO_Case
::processCaseActivity($caseActivityParams);
229 $caseActivityParams = [
230 'activityID' => $form->openCaseActivityId
,
231 'mainActivityId' => $newActivity->id
,
233 CRM_Activity_BAO_Activity
::copyExtendedActivityData($caseActivityParams);
238 $params['statusMsg'] = ts('Case Start Date changed successfully.');