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 case activity.
37 class CRM_Case_Form_Case
extends CRM_Core_Form
{
44 public $_context = 'case';
49 public $_caseId = NULL;
54 public $_currentlyViewedContactId = NULL;
59 public $_activityTypeFile = NULL;
62 * Logged in contact Id
64 public $_currentUserId = NULL;
69 public $_activityTypeId = NULL;
74 public $_activityId = NULL;
84 public $_caseTypeId = NULL;
87 * Explicitly declare the entity api name.
89 public function getDefaultEntity() {
94 * Get the entity id being edited.
98 public function getEntityId() {
99 return $this->_caseId
;
103 * Get the entity subtype ID being edited
109 public function getEntitySubTypeId($subTypeId) {
113 return $this->_caseTypeId
;
117 * Build the form object.
119 public function preProcess() {
120 if (empty($this->_action
)) {
121 $this->_action
= CRM_Core_Action
::ADD
;
124 $this->_caseId
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
126 $this->_currentlyViewedContactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
128 if ($this->_action
& CRM_Core_Action
::ADD
&& !$this->_currentlyViewedContactId
) {
129 // check for add contacts permissions
130 if (!CRM_Core_Permission
::check('add contacts')) {
131 CRM_Utils_System
::permissionDenied();
137 if (!CRM_Core_Permission
::checkActionPermission('CiviCase', $this->_action
)) {
138 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
141 if ($this->_action
& CRM_Core_Action
::DELETE ||
$this->_action
& CRM_Core_Action
::RENEW
) {
145 if (!$this->_caseId
) {
146 $caseAttributes = array(
147 'case_type_id' => ts('Case Type'),
148 'status_id' => ts('Case Status'),
149 'medium_id' => ts('Activity Medium'),
152 foreach ($caseAttributes as $key => $label) {
153 if (!CRM_Case_BAO_Case
::buildOptions($key, 'create')) {
154 CRM_Core_Error
::fatal(ts('You do not have any active %1', array(1 => $label)));
159 if ($this->_action
& CRM_Core_Action
::ADD
) {
160 $this->_activityTypeId
= CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Open Case');
161 if (!$this->_activityTypeId
) {
162 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.'));
166 //check for case permissions.
167 if (!CRM_Case_BAO_Case
::accessCiviCase()) {
168 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
170 if (($this->_action
& CRM_Core_Action
::ADD
) &&
171 (!CRM_Core_Permission
::check('access all cases and activities') &&
172 !CRM_Core_Permission
::check('add cases')
175 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
178 if ($this->_activityTypeFile
= CRM_Activity_BAO_Activity
::getFileForActivityTypeId($this->_activityTypeId
,
182 $this->assign('activityTypeFile', $this->_activityTypeFile
);
185 $details = CRM_Case_PseudoConstant
::caseActivityType(FALSE);
187 CRM_Utils_System
::setTitle($details[$this->_activityTypeId
]['label']);
188 $this->assign('activityType', $details[$this->_activityTypeId
]['label']);
189 $this->assign('activityTypeDescription', $details[$this->_activityTypeId
]['description']);
191 if (isset($this->_currentlyViewedContactId
)) {
192 $contact = new CRM_Contact_DAO_Contact();
193 $contact->id
= $this->_currentlyViewedContactId
;
194 if (!$contact->find(TRUE)) {
195 CRM_Core_Error
::statusBounce(ts('Client contact does not exist: %1', array(1 => $this->_currentlyViewedContactId
)));
197 $this->assign('clientName', $contact->display_name
);
200 $session = CRM_Core_Session
::singleton();
201 $this->_currentUserId
= $session->get('userID');
203 //Add activity custom data is included in this page
204 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $this->_activityTypeId
, 1, 'Activity');
205 $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}";
206 $className::preProcess($this);
207 $activityGroupTree = $this->_groupTree
;
209 // Add case custom data to form
210 $caseTypeId = CRM_Utils_Array
::value('case_type_id', CRM_Utils_Request
::exportValues(), $this->_caseTypeId
);
211 CRM_Custom_Form_CustomData
::addToForm($this, $caseTypeId);
213 // so that grouptree is not populated with case fields, since the grouptree is used
214 // for populating activity custom fields.
215 $this->_groupTree
= $activityGroupTree;
219 * Set default values for the form.
221 public function setDefaultValues() {
222 if ($this->_action
& CRM_Core_Action
::DELETE ||
$this->_action
& CRM_Core_Action
::RENEW
) {
225 $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}";
226 $defaults = $className::setDefaultValues($this);
227 $defaults = array_merge($defaults, CRM_Custom_Form_CustomData
::setDefaultValues($this));
231 public function buildQuickForm() {
232 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
233 $isMultiClient = $xmlProcessorProcess->getAllowMultipleCaseClients();
234 $this->assign('multiClient', $isMultiClient);
236 if ($this->_action
& CRM_Core_Action
::DELETE ||
$this->_action
& CRM_Core_Action
::RENEW
) {
237 $title = ts('Delete');
238 if ($this->_action
& CRM_Core_Action
::RENEW
) {
239 $title = ts('Restore');
241 $this->addButtons(array(
245 'spacing' => ' ',
250 'name' => ts('Cancel'),
257 // Add the activity custom data to the form
258 CRM_Custom_Form_CustomData
::buildQuickForm($this);
260 // we don't want to show button on top of custom form
261 $this->assign('noPreCustomButton', TRUE);
263 $s = CRM_Core_DAO
::getAttribute('CRM_Activity_DAO_Activity', 'subject');
267 $this->add('text', 'activity_subject', ts('Subject'),
268 array_merge($s, array(
269 'maxlength' => '128',
273 $tags = CRM_Core_BAO_Tag
::getColorTags('civicrm_case');
276 $this->add('select2', 'tag', ts('Tags'), $tags, FALSE,
277 array('class' => 'huge', 'multiple' => 'multiple')
282 $parentNames = CRM_Core_BAO_Tag
::getTagSet('civicrm_case');
283 CRM_Core_Form_Tag
::buildQuickForm($this, $parentNames, 'civicrm_case', NULL, FALSE, TRUE);
285 $this->addButtons(array(
288 'name' => ts('Save'),
289 'spacing' => ' ',
294 'name' => ts('Cancel'),
299 $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}";
300 $className::buildQuickForm($this);
304 * Add local and global form rules.
308 public function addRules() {
309 if ($this->_action
& CRM_Core_Action
::DELETE ||
$this->_action
& CRM_Core_Action
::RENEW
) {
312 $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}";
313 $this->addFormRule(array($className, 'formRule'), $this);
314 $this->addFormRule(array('CRM_Case_Form_Case', 'formRule'), $this);
318 * Global validation rules for the form.
320 * @param array $values
321 * Posted values of the form.
324 * @param CRM_Core_Form $form
327 * list of errors to be posted back to the form
329 public static function formRule($values, $files, $form) {
334 * Wrapper for unit testing the post process submit function.
337 * @param $activityTypeFile
340 * @return CRM_Case_BAO_Case
342 public function testSubmit($params, $activityTypeFile, $contactId, $context = "case") {
343 $this->controller
= new CRM_Core_Controller();
345 $this->_activityTypeFile
= $activityTypeFile;
346 $this->_currentUserId
= $contactId;
347 $this->_context
= $context;
349 return $this->submit($params);
353 * Submit the form with given params.
357 public function submit(&$params) {
358 $params['now'] = date("Ymd");
360 // 1. call begin post process
361 if ($this->_activityTypeFile
) {
362 $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}";
363 $className::beginPostProcess($this, $params);
366 if (!empty($params['hidden_custom']) &&
367 !isset($params['custom'])
369 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess(
376 // 2. create/edit case
377 if (!empty($params['case_type_id'])) {
378 $params['case_type'] = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseType', $params['case_type_id'], 'name', 'id');
379 $params['subject'] = $params['activity_subject'];
381 $caseObj = CRM_Case_BAO_Case
::create($params);
382 $this->_caseId
= $params['case_id'] = $caseObj->id
;
383 // unset any ids, custom data
384 unset($params['id'], $params['custom']);
386 // add tags if exists
387 $tagParams = array();
388 if (!empty($params['tag'])) {
389 $tagParams = array();
390 if (!is_array($params['tag'])) {
391 $params['tag'] = explode(',', $params['tag']);
393 foreach ($params['tag'] as $tag) {
394 $tagParams[$tag] = 1;
397 CRM_Core_BAO_EntityTag
::create($tagParams, 'civicrm_case', $caseObj->id
);
400 if (isset($params['case_taglist']) && !empty($params['case_taglist'])) {
401 CRM_Core_Form_Tag
::postProcess($params['case_taglist'], $caseObj->id
, 'civicrm_case', $this);
405 $url = CRM_Utils_System
::url('civicrm/contact/view/case',
406 "reset=1&action=view&cid={$this->_currentlyViewedContactId}&id={$caseObj->id}"
408 CRM_Core_Session
::singleton()->pushUserContext($url);
410 // 3. format activity custom data
411 if (!empty($params['hidden_custom'])) {
412 $customFields = CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE, $this->_activityTypeId
);
413 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
414 CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE,
418 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
424 // 4. call end post process
425 if ($this->_activityTypeFile
) {
426 $className::endPostProcess($this, $params);
433 * Process the form submission.
435 public function postProcess() {
436 $transaction = new CRM_Core_Transaction();
438 // check if dedupe button, if so return.
439 $buttonName = $this->controller
->getButtonName();
440 if (isset($this->_dedupeButtonName
) && $buttonName == $this->_dedupeButtonName
) {
444 if ($this->_action
& CRM_Core_Action
::DELETE
) {
445 $caseDelete = CRM_Case_BAO_Case
::deleteCase($this->_caseId
, TRUE);
447 CRM_Core_Session
::setStatus(ts('You can view and / or restore deleted cases by checking the "Deleted Cases" option under Find Cases.'), ts('Case Deleted'), 'success');
452 if ($this->_action
& CRM_Core_Action
::RENEW
) {
453 $caseRestore = CRM_Case_BAO_Case
::restoreCase($this->_caseId
);
455 CRM_Core_Session
::setStatus(ts('The selected case has been restored.'), ts('Restored'), 'success');
459 // store the submitted values in an array
460 $params = $this->controller
->exportValues($this->_name
);
461 $this->submit($params);
463 CRM_Core_Session
::setStatus($params['statusMsg'], ts('Saved'), 'success');