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 generates form components for OpenCase Activity.
37 class CRM_Case_Form_Activity_OpenCase
{
40 * The id of the client associated with this case.
47 * @param CRM_Core_Form $form
49 public static function preProcess(&$form) {
50 //get multi client case configuration
51 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
52 $form->_allowMultiClient
= (bool) $xmlProcessorProcess->getAllowMultipleCaseClients();
54 if ($form->_context
== 'caseActivity') {
55 $contactID = CRM_Utils_Request
::retrieve('cid', 'Positive', $form);
56 $atype = CRM_Core_OptionGroup
::getValue('activity_type',
57 'Change Case Start Date',
60 $caseId = CRM_Utils_Array
::first($form->_caseId
);
61 $form->assign('changeStartURL', CRM_Utils_System
::url('civicrm/case/activity',
62 "action=add&reset=1&cid=$contactID&caseid={$caseId}&atype=$atype"
68 $form->_context
= CRM_Utils_Request
::retrieve('context', 'String', $form);
69 $form->_contactID
= CRM_Utils_Request
::retrieve('cid', 'Positive', $form);
70 $form->assign('context', $form->_context
);
72 // check if the case type id passed in url is a valid one
73 $caseTypeId = CRM_Utils_Request
::retrieve('ctype', 'Positive', $form);
74 $caseTypes = CRM_Case_BAO_Case
::buildOptions('case_type_id', 'create');
75 $form->_caseTypeId
= array_key_exists($caseTypeId, $caseTypes) ?
$caseTypeId : NULL;
77 // check if the case status id passed in url is a valid one
78 $caseStatusId = CRM_Utils_Request
::retrieve('case_status_id', 'Positive', $form);
79 $caseStatus = CRM_Case_PseudoConstant
::caseStatus();
80 $form->_caseStatusId
= array_key_exists($caseStatusId, $caseStatus) ?
$caseStatusId : NULL;
83 CRM_Core_BAO_File
::buildAttachment($form, 'civicrm_activity', $form->_activityId
);
84 $session = CRM_Core_Session
::singleton();
85 $session->pushUserContext(CRM_Utils_System
::url('civicrm/case', 'reset=1'));
89 * Set default values for the form. For edit/view mode
90 * the default values are retrieved from the database
93 * @param CRM_Core_Form $form
95 public static function setDefaultValues(&$form) {
97 if ($form->_context
== 'caseActivity') {
101 list($defaults['start_date'], $defaults['start_date_time']) = CRM_Utils_Date
::setDateDefaults(NULL, 'activityDateTime');
103 // set default case status, case type, encounter medium, location type and phone type defaults are set in DB
104 if ($form->_caseStatusId
) {
105 $caseStatus = $form->_caseStatusId
;
108 $caseStatus = CRM_Core_OptionGroup
::values('case_status', FALSE, FALSE, FALSE, 'AND is_default = 1');
109 if (count($caseStatus) == 1) {
110 $caseStatus = key($caseStatus); //$defaults['status_id'] = key($caseStatus);
113 $defaults['status_id'] = $caseStatus;
115 // set default case type passed in url
116 if ($form->_caseTypeId
) {
117 $defaults['case_type_id'] = $form->_caseTypeId
;
120 // TODO: Not possible yet to set a default case type in the system
121 // For now just add the convenience of auto-selecting if there is only one option
122 $caseTypes = CRM_Case_BAO_Case
::buildOptions('case_type_id', 'create');
123 if (count($caseTypes) == 1) {
125 $defaults['case_type_id'] = key($caseTypes);
129 $medium = CRM_Core_OptionGroup
::values('encounter_medium', FALSE, FALSE, FALSE, 'AND is_default = 1');
130 if (count($medium) == 1) {
131 $defaults['medium_id'] = key($medium);
134 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
135 if ($defaultLocationType->id
) {
136 $defaults['location[1][location_type_id]'] = $defaultLocationType->id
;
139 $phoneType = CRM_Core_OptionGroup
::values('phone_type', FALSE, FALSE, FALSE, 'AND is_default = 1');
140 if (count($phoneType) == 1) {
141 $defaults['location[1][phone][1][phone_type_id]'] = key($phoneType);
148 * @param CRM_Case_Form_Case $form
150 public static function buildQuickForm(&$form) {
151 if ($form->_context
== 'caseActivity') {
154 if ($form->_context
== 'standalone') {
155 $form->addEntityRef('client_id', ts('Client'), array(
157 'multiple' => $form->_allowMultiClient
,
161 $element = $form->addField('case_type_id', array(
162 'context' => 'create',
164 'onchange' => "CRM.buildCustomData('Case', this.value);",
166 if ($form->_caseTypeId
) {
170 $csElement = $form->addField('status_id', array(
171 'context' => 'create',
174 if ($form->_caseStatusId
) {
175 $csElement->freeze();
178 $form->add('text', 'duration', ts('Activity Duration'), array('size' => 4, 'maxlength' => 8));
179 $form->addRule('duration', ts('Please enter the duration as number of minutes (integers only).'), 'positiveInteger');
181 if ($form->_currentlyViewedContactId
) {
182 list($displayName) = CRM_Contact_BAO_Contact
::getDisplayAndImage($form->_currentlyViewedContactId
);
183 $form->assign('clientName', $displayName);
186 $form->addDate('start_date', ts('Case Start Date'), TRUE, array('formatType' => 'activityDateTime'));
188 $form->addField('medium_id', array('entity' => 'activity', 'context' => 'create'), TRUE);
190 // calling this field activity_location to prevent conflict with contact location fields
191 $form->add('text', 'activity_location', ts('Location'), CRM_Core_DAO
::getAttribute('CRM_Activity_DAO_Activity', 'location'));
193 $form->add('wysiwyg', 'activity_details', ts('Details'), array('rows' => 4, 'cols' => 60), FALSE);
195 $form->addButtons(array(
198 'name' => ts('Save'),
203 'name' => ts('Save and New'),
208 'name' => ts('Cancel'),
215 * Process the form submission.
218 * @param CRM_Core_Form $form
219 * @param array $params
221 public static function beginPostProcess(&$form, &$params) {
222 if ($form->_context
== 'caseActivity') {
226 if ($form->_context
== 'standalone') {
227 $params['client_id'] = explode(',', $params['client_id']);
228 $form->_currentlyViewedContactId
= $params['client_id'][0];
231 // for open case start date should be set to current date
232 $params['start_date'] = CRM_Utils_Date
::processDate($params['start_date'], $params['start_date_time']);
234 // rename activity_location param to the correct column name for activity DAO
235 $params['location'] = CRM_Utils_Array
::value('activity_location', $params);
238 CRM_Core_BAO_File
::formatAttachment(
248 * Global validation rules for the form.
252 * @param CRM_Core_Form $form
255 * list of errors to be posted back to the form
257 public static function formRule($fields, $files, $form) {
258 if ($form->_context
== 'caseActivity') {
267 * Process the form submission.
269 * @param CRM_Core_Form $form
270 * @param array $params
272 public static function endPostProcess(&$form, &$params) {
273 if ($form->_context
== 'caseActivity') {
277 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
278 $isMultiClient = $xmlProcessorProcess->getAllowMultipleCaseClients();
280 if (!$isMultiClient && !$form->_currentlyViewedContactId
) {
281 CRM_Core_Error
::fatal('Required parameter missing for OpenCase - end post processing');
284 if (!$form->_currentUserId ||
285 !$params['case_id'] ||
286 !$params['case_type']
288 CRM_Core_Error
::fatal('Required parameter missing for OpenCase - end post processing');
291 // 1. create case-contact
292 if ($isMultiClient && $form->_context
== 'standalone') {
293 foreach ($params['client_id'] as $cliId) {
295 CRM_Core_Error
::fatal('client_id cannot be empty');
297 $contactParams = array(
298 'case_id' => $params['case_id'],
299 'contact_id' => $cliId,
301 CRM_Case_BAO_CaseContact
::create($contactParams);
305 $contactParams = array(
306 'case_id' => $params['case_id'],
307 'contact_id' => $form->_currentlyViewedContactId
,
309 CRM_Case_BAO_CaseContact
::create($contactParams);
312 // 2. initiate xml processor
313 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
315 $xmlProcessorParams = array(
316 'clientID' => $form->_currentlyViewedContactId
,
317 'creatorID' => $form->_currentUserId
,
318 'standardTimeline' => 1,
319 'activityTypeName' => 'Open Case',
320 'caseID' => $params['case_id'],
321 'subject' => $params['activity_subject'],
322 'location' => $params['location'],
323 'activity_date_time' => $params['start_date'],
324 'duration' => CRM_Utils_Array
::value('duration', $params),
325 'medium_id' => $params['medium_id'],
326 'details' => $params['activity_details'],
327 'relationship_end_date' => CRM_Utils_Array
::value('end_date', $params),
330 if (array_key_exists('custom', $params) && is_array($params['custom'])) {
331 $xmlProcessorParams['custom'] = $params['custom'];
334 // Add parameters for attachments
335 $numAttachments = Civi
::settings()->get('max_attachments');
336 for ($i = 1; $i <= $numAttachments; $i++
) {
337 $attachName = "attachFile_$i";
338 if (isset($params[$attachName]) && !empty($params[$attachName])) {
339 $xmlProcessorParams[$attachName] = $params[$attachName];
343 $xmlProcessor->run($params['case_type'], $xmlProcessorParams);
346 $params['statusMsg'] = ts('Case opened successfully.');
348 $buttonName = $form->controller
->getButtonName();
349 $session = CRM_Core_Session
::singleton();
350 if ($buttonName == $form->getButtonName('upload', 'new')) {
351 if ($form->_context
== 'standalone') {
352 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/case/add',
353 'reset=1&action=add&context=standalone'
357 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/case',
358 "reset=1&action=add&context=case&cid={$form->_contactID}"