Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * This class generates form components for case activity | |
38 | * | |
39 | */ | |
40 | class CRM_Case_Form_Case extends CRM_Core_Form { | |
41 | ||
42 | /** | |
43 | * The context | |
44 | * | |
45 | * @var string | |
46 | */ | |
47 | public $_context = 'case'; | |
48 | ||
49 | /** | |
50 | * Case Id | |
51 | */ | |
52 | public $_caseId = NULL; | |
53 | ||
54 | /** | |
55 | * Client Id | |
56 | */ | |
57 | public $_currentlyViewedContactId = NULL; | |
58 | ||
59 | /** | |
60 | * Activity Type File | |
61 | */ | |
62 | public $_activityTypeFile = NULL; | |
63 | ||
64 | /** | |
100fef9d | 65 | * Logged in contact Id |
6a488035 TO |
66 | */ |
67 | public $_currentUserId = NULL; | |
68 | ||
69 | /** | |
100fef9d | 70 | * Activity type Id |
6a488035 TO |
71 | */ |
72 | public $_activityTypeId = NULL; | |
73 | ||
74 | /** | |
100fef9d | 75 | * Activity type Id |
6a488035 TO |
76 | */ |
77 | public $_activityId = NULL; | |
78 | ||
79 | /** | |
100fef9d | 80 | * Action |
6a488035 TO |
81 | */ |
82 | public $_action; | |
83 | ||
74fb6e99 | 84 | /** |
100fef9d | 85 | * Case type id |
74fb6e99 PJ |
86 | */ |
87 | public $_caseTypeId = NULL; | |
88 | ||
6a488035 | 89 | /** |
c490a46a | 90 | * Build the form object |
6a488035 | 91 | * |
355ba699 | 92 | * @return void |
6a488035 | 93 | */ |
00be9182 | 94 | public function preProcess() { |
6a488035 TO |
95 | $this->_cdType = CRM_Utils_Array::value('type', $_GET); |
96 | $this->assign('cdType', FALSE); | |
97 | if ($this->_cdType) { | |
98 | $this->assign('cdType', TRUE); | |
99 | return CRM_Custom_Form_CustomData::preProcess($this); | |
100 | } | |
101 | ||
102 | $this->_caseId = CRM_Utils_Request::retrieve('id', 'Positive', $this); | |
103 | ||
104 | $this->_currentlyViewedContactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this); | |
105 | ||
106 | if ($this->_action & CRM_Core_Action::ADD && !$this->_currentlyViewedContactId) { | |
107 | // check for add contacts permissions | |
108 | if (!CRM_Core_Permission::check('add contacts')) { | |
109 | CRM_Utils_System::permissionDenied(); | |
110 | return; | |
111 | } | |
112 | } | |
113 | ||
114 | //CRM-4418 | |
115 | if (!CRM_Core_Permission::checkActionPermission('CiviCase', $this->_action)) { | |
0499b0ad | 116 | CRM_Core_Error::fatal(ts('You do not have permission to access this page.')); |
6a488035 TO |
117 | } |
118 | ||
119 | if ($this->_action & CRM_Core_Action::DELETE || $this->_action & CRM_Core_Action::RENEW) { | |
120 | return TRUE; | |
121 | } | |
122 | ||
123 | if (!$this->_caseId) { | |
124 | $caseAttributes = array('case_type' => CRM_Case_PseudoConstant::caseType(), | |
125 | 'case_status' => CRM_Case_PseudoConstant::caseStatus(), | |
126 | 'encounter_medium' => CRM_Case_PseudoConstant::encounterMedium(), | |
127 | ); | |
128 | ||
129 | foreach ($caseAttributes as $key => $values) { | |
130 | if (empty($values)) { | |
131 | CRM_Core_Error::fatal(ts('You do not have any active %1', | |
132 | array(1 => str_replace('_', ' ', $key)) | |
133 | )); | |
134 | break; | |
135 | } | |
136 | } | |
137 | } | |
138 | ||
139 | if ($this->_action & CRM_Core_Action::ADD) { | |
140 | $this->_activityTypeId = CRM_Core_OptionGroup::getValue('activity_type', | |
141 | 'Open Case', | |
142 | 'name' | |
143 | ); | |
144 | if (!$this->_activityTypeId) { | |
145 | CRM_Core_Error::fatal(ts('The Open Case activity type is missing or disabled. Please have your site administrator check Administer > Option Lists > Activity Types for the CiviCase component.')); | |
146 | } | |
147 | } | |
148 | ||
149 | //check for case permissions. | |
150 | if (!CRM_Case_BAO_Case::accessCiviCase()) { | |
151 | CRM_Core_Error::fatal(ts('You are not authorized to access this page.')); | |
152 | } | |
153 | if (($this->_action & CRM_Core_Action::ADD) && | |
154 | (!CRM_Core_Permission::check('access all cases and activities') && | |
155 | !CRM_Core_Permission::check('add cases') | |
156 | ) | |
157 | ) { | |
158 | CRM_Core_Error::fatal(ts('You are not authorized to access this page.')); | |
159 | } | |
160 | ||
161 | if ($this->_activityTypeFile = | |
162 | CRM_Activity_BAO_Activity::getFileForActivityTypeId($this->_activityTypeId, | |
163 | 'Case' | |
164 | ) | |
165 | ) { | |
166 | $this->assign('activityTypeFile', $this->_activityTypeFile); | |
167 | } | |
168 | ||
169 | $details = CRM_Case_PseudoConstant::caseActivityType(FALSE); | |
170 | ||
171 | CRM_Utils_System::setTitle($details[$this->_activityTypeId]['label']); | |
172 | $this->assign('activityType', $details[$this->_activityTypeId]['label']); | |
173 | $this->assign('activityTypeDescription', $details[$this->_activityTypeId]['description']); | |
174 | ||
175 | if (isset($this->_currentlyViewedContactId)) { | |
176 | $contact = new CRM_Contact_DAO_Contact(); | |
177 | $contact->id = $this->_currentlyViewedContactId; | |
178 | if (!$contact->find(TRUE)) { | |
179 | CRM_Core_Error::statusBounce(ts('Client contact does not exist: %1', array(1 => $this->_currentlyViewedContactId))); | |
180 | } | |
181 | $this->assign('clientName', $contact->display_name); | |
182 | } | |
183 | ||
184 | ||
185 | $session = CRM_Core_Session::singleton(); | |
186 | $this->_currentUserId = $session->get('userID'); | |
187 | ||
188 | //when custom data is included in this page | |
189 | CRM_Custom_Form_CustomData::preProcess($this, NULL, $this->_activityTypeId, 1, 'Activity'); | |
0e6e8724 DL |
190 | $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}"; |
191 | $className::preProcess($this); | |
6a488035 TO |
192 | $activityGroupTree = $this->_groupTree; |
193 | ||
194 | // for case custom fields to populate with defaults | |
a7488080 | 195 | if (!empty($_POST['hidden_custom'])) { |
6a488035 TO |
196 | CRM_Custom_Form_CustomData::preProcess($this); |
197 | CRM_Custom_Form_CustomData::buildQuickForm($this); | |
198 | } | |
199 | ||
200 | // so that grouptree is not populated with case fields, since the grouptree is used | |
201 | // for populating activity custom fields. | |
202 | $this->_groupTree = $activityGroupTree; | |
203 | } | |
204 | ||
205 | /** | |
c490a46a | 206 | * Set default values for the form. For edit/view mode |
6a488035 TO |
207 | * the default values are retrieved from the database |
208 | * | |
6a488035 | 209 | * |
355ba699 | 210 | * @return void |
6a488035 | 211 | */ |
00be9182 | 212 | public function setDefaultValues() { |
6a488035 TO |
213 | if ($this->_action & CRM_Core_Action::DELETE || $this->_action & CRM_Core_Action::RENEW || $this->_cdType) { |
214 | return TRUE; | |
215 | } | |
0e6e8724 DL |
216 | $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}"; |
217 | $defaults = $className::setDefaultValues($this); | |
6a488035 TO |
218 | $defaults = array_merge($defaults, CRM_Custom_Form_CustomData::setDefaultValues($this)); |
219 | return $defaults; | |
220 | } | |
221 | ||
222 | public function buildQuickForm() { | |
223 | $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process(); | |
224 | $isMultiClient = $xmlProcessorProcess->getAllowMultipleCaseClients(); | |
225 | $this->assign('multiClient', $isMultiClient); | |
226 | ||
227 | if ($this->_action & CRM_Core_Action::DELETE || $this->_action & CRM_Core_Action::RENEW) { | |
228 | $title = 'Delete'; | |
229 | if ($this->_action & CRM_Core_Action::RENEW) { | |
230 | $title = 'Restore'; | |
231 | } | |
232 | $this->addButtons(array( | |
233 | array( | |
234 | 'type' => 'next', | |
235 | 'name' => $title, | |
236 | 'spacing' => ' ', | |
237 | 'isDefault' => TRUE, | |
238 | ), | |
239 | array( | |
240 | 'type' => 'cancel', | |
241 | 'name' => ts('Cancel'), | |
242 | ), | |
243 | ) | |
244 | ); | |
245 | return; | |
246 | } | |
247 | ||
248 | if ($this->_cdType) { | |
249 | return CRM_Custom_Form_CustomData::buildQuickForm($this); | |
250 | } | |
251 | //need to assign custom data type and subtype to the template | |
252 | $this->assign('customDataType', 'Case'); | |
253 | ||
254 | CRM_Custom_Form_CustomData::buildQuickForm($this); | |
255 | // we don't want to show button on top of custom form | |
256 | $this->assign('noPreCustomButton', TRUE); | |
257 | ||
258 | $s = CRM_Core_DAO::getAttribute('CRM_Activity_DAO_Activity', 'subject'); | |
259 | if (!is_array($s)) { | |
260 | $s = array(); | |
261 | } | |
262 | $this->add('text', 'activity_subject', ts('Subject'), | |
263 | array_merge($s, array( | |
264 | 'maxlength' => '128')), TRUE | |
265 | ); | |
266 | ||
e0f9d6a2 | 267 | CRM_Core_BAO_Tag::getTags('civicrm_case', $tags, NULL, |
47358d92 | 268 | ' ', TRUE); |
269 | ||
6a488035 TO |
270 | if (!empty($tags)) { |
271 | $this->add('select', 'tag', ts('Select Tags'), $tags, FALSE, | |
ab345ca5 | 272 | array('id' => 'tags', 'multiple' => 'multiple', 'class' => 'crm-select2') |
6a488035 TO |
273 | ); |
274 | } | |
275 | ||
276 | // build tag widget | |
277 | $parentNames = CRM_Core_BAO_Tag::getTagSet('civicrm_case'); | |
95ef220a | 278 | CRM_Core_Form_Tag::buildQuickForm($this, $parentNames, 'civicrm_case', NULL, FALSE, TRUE); |
6a488035 TO |
279 | |
280 | $this->addButtons(array( | |
281 | array( | |
282 | 'type' => 'next', | |
283 | 'name' => ts('Save'), | |
284 | 'spacing' => ' ', | |
285 | 'isDefault' => TRUE, | |
286 | ), | |
287 | array( | |
288 | 'type' => 'cancel', | |
289 | 'name' => ts('Cancel'), | |
290 | ), | |
291 | ) | |
292 | ); | |
293 | ||
0e6e8724 DL |
294 | $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}"; |
295 | $className::buildQuickForm($this); | |
6a488035 TO |
296 | } |
297 | ||
298 | /** | |
299 | * Add local and global form rules | |
300 | * | |
6a488035 TO |
301 | * |
302 | * @return void | |
303 | */ | |
00be9182 | 304 | public function addRules() { |
6a488035 TO |
305 | if ($this->_action & CRM_Core_Action::DELETE || $this->_action & CRM_Core_Action::RENEW || $this->_cdType) { |
306 | return TRUE; | |
307 | } | |
0e6e8724 DL |
308 | $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}"; |
309 | $this->addFormRule(array($className, 'formRule'), $this); | |
6a488035 TO |
310 | $this->addFormRule(array('CRM_Case_Form_Case', 'formRule'), $this); |
311 | } | |
312 | ||
313 | /** | |
100fef9d | 314 | * Global validation rules for the form |
6a488035 TO |
315 | * |
316 | * @param array $values posted values of the form | |
317 | * | |
da6b46f4 | 318 | * @param $files |
c490a46a | 319 | * @param CRM_Core_Form $form |
da6b46f4 | 320 | * |
6a488035 TO |
321 | * @return array list of errors to be posted back to the form |
322 | * @static | |
6a488035 | 323 | */ |
00be9182 | 324 | public static function formRule($values, $files, $form) { |
6a488035 TO |
325 | return TRUE; |
326 | } | |
327 | ||
328 | /** | |
c490a46a | 329 | * Process the form submission |
6a488035 | 330 | * |
6a488035 | 331 | * |
355ba699 | 332 | * @return void |
6a488035 TO |
333 | */ |
334 | public function postProcess() { | |
335 | $transaction = new CRM_Core_Transaction(); | |
336 | ||
337 | // check if dedupe button, if so return. | |
338 | $buttonName = $this->controller->getButtonName(); | |
339 | if (isset($this->_dedupeButtonName) && $buttonName == $this->_dedupeButtonName) { | |
340 | return; | |
341 | } | |
342 | ||
343 | if ($this->_action & CRM_Core_Action::DELETE) { | |
344 | $statusMsg = NULL; | |
345 | $caseDelete = CRM_Case_BAO_Case::deleteCase($this->_caseId, TRUE); | |
346 | if ($caseDelete) { | |
347 | $statusMsg = ts('The selected case has been moved to the Trash. You can view and / or restore deleted cases by checking the "Deleted Cases" option under Find Cases.<br />'); | |
348 | } | |
349 | CRM_Core_Session::setStatus($statusMsg, ts('Case Deleted'), 'success'); | |
350 | return; | |
351 | } | |
352 | ||
353 | if ($this->_action & CRM_Core_Action::RENEW) { | |
354 | $statusMsg = NULL; | |
355 | $caseRestore = CRM_Case_BAO_Case::restoreCase($this->_caseId); | |
356 | if ($caseRestore) { | |
357 | $statusMsg = ts('The selected case has been restored.<br />'); | |
358 | } | |
359 | CRM_Core_Session::setStatus($statusMsg, ts('Restored'), 'success'); | |
360 | return; | |
361 | } | |
362 | // store the submitted values in an array | |
363 | $params = $this->controller->exportValues($this->_name); | |
364 | $params['now'] = date("Ymd"); | |
365 | ||
366 | ||
367 | // 1. call begin post process | |
368 | if ($this->_activityTypeFile) { | |
0e6e8724 DL |
369 | $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}"; |
370 | $className::beginPostProcess($this, $params ); | |
6a488035 TO |
371 | } |
372 | ||
a7488080 | 373 | if (!empty($params['hidden_custom']) && |
6a488035 TO |
374 | !isset($params['custom']) |
375 | ) { | |
376 | $customFields = array(); | |
0e6e8724 DL |
377 | $params['custom'] = CRM_Core_BAO_CustomField::postProcess( |
378 | $params, | |
6a488035 TO |
379 | $customFields, |
380 | NULL, | |
381 | 'Case' | |
382 | ); | |
383 | } | |
384 | ||
385 | // 2. create/edit case | |
a7488080 | 386 | if (!empty($params['case_type_id'])) { |
d14b35a4 | 387 | $params['case_type'] = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $params['case_type_id'], 'name', 'id'); |
6a488035 | 388 | $params['subject'] = $params['activity_subject']; |
6a488035 TO |
389 | } |
390 | $caseObj = CRM_Case_BAO_Case::create($params); | |
391 | $params['case_id'] = $caseObj->id; | |
392 | // unset any ids, custom data | |
393 | unset($params['id'], $params['custom']); | |
394 | ||
395 | // add tags if exists | |
396 | $tagParams = array(); | |
397 | if (!empty($params['tag'])) { | |
398 | $tagParams = array(); | |
399 | foreach ($params['tag'] as $tag) { | |
400 | $tagParams[$tag] = 1; | |
401 | } | |
402 | } | |
403 | CRM_Core_BAO_EntityTag::create($tagParams, 'civicrm_case', $caseObj->id); | |
404 | ||
405 | //save free tags | |
406 | if (isset($params['case_taglist']) && !empty($params['case_taglist'])) { | |
407 | CRM_Core_Form_Tag::postProcess($params['case_taglist'], $caseObj->id, 'civicrm_case', $this); | |
408 | } | |
409 | ||
410 | // user context | |
411 | $url = CRM_Utils_System::url('civicrm/contact/view/case', | |
412 | "reset=1&action=view&cid={$this->_currentlyViewedContactId}&id={$caseObj->id}" | |
413 | ); | |
414 | $session = CRM_Core_Session::singleton(); | |
415 | $session->pushUserContext($url); | |
416 | ||
417 | // 3. format activity custom data | |
a7488080 | 418 | if (!empty($params['hidden_custom'])) { |
6a488035 TO |
419 | $customFields = CRM_Core_BAO_CustomField::getFields('Activity', FALSE, FALSE, $this->_activityTypeId); |
420 | $customFields = CRM_Utils_Array::crmArrayMerge($customFields, | |
421 | CRM_Core_BAO_CustomField::getFields('Activity', FALSE, FALSE, | |
422 | NULL, NULL, TRUE | |
423 | ) | |
424 | ); | |
425 | $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params, | |
426 | $customFields, | |
427 | $this->_activityId, | |
428 | 'Activity' | |
429 | ); | |
430 | } | |
431 | ||
432 | // 4. call end post process | |
433 | if ($this->_activityTypeFile) { | |
0e6e8724 | 434 | $className::endPostProcess($this, $params ); |
6a488035 TO |
435 | } |
436 | ||
437 | // 5. auto populate activites | |
438 | ||
439 | // 6. set status | |
79dc2175 | 440 | CRM_Core_Session::setStatus($params['statusMsg'], ts('Saved'), 'success'); |
6a488035 TO |
441 | } |
442 | } |