CRM/Case/Form/Activity/ChangeCaseType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * This class generates form components for OpenCase Activity.
  36  */
  37 class CRM_Case_Form_Activity_ChangeCaseType {
  38
  39   /**
  40    * @param CRM_Core_Form $form
  41    *
  42    * @throws Exception
  43    */
  44   public static function preProcess(&$form) {
  45     if (!isset($form->_caseId)) {
  46       CRM_Core_Error::fatal(ts('Case Id not found.'));
  47     }
  48   }
  49
  50   /**
  51    * Set default values for the form.
  52    *
  53    * For edit/view mode the default values are retrieved from the database.
  54    *
  55    * @param CRM_Core_Form $form
  56    *
  57    * @return array
  58    */
  59   public static function setDefaultValues(&$form) {
  60     $defaults = array();
  61
  62     $defaults['is_reset_timeline'] = 1;
  63
  64     $defaults['reset_date_time'] = date('Y-m-d H:i:s');
  65     $defaults['case_type_id'] = $form->_caseTypeId;
  66
  67     return $defaults;
  68   }
  69
  70   /**
  71    * @param CRM_Core_Form $form
  72    */
  73   public static function buildQuickForm(&$form) {
  74     $form->removeElement('status_id');
  75     $form->removeElement('priority_id');
  76
  77     $caseId = CRM_Utils_Array::first($form->_caseId);
  78     $form->_caseType = CRM_Case_BAO_Case::buildOptions('case_type_id', 'create');
  79     $form->_caseTypeId = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_Case',
  80       $caseId,
  81       'case_type_id'
  82     );
  83     if (!in_array($form->_caseTypeId, $form->_caseType)) {
  84       $form->_caseType[$form->_caseTypeId] = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $form->_caseTypeId, 'title');
  85     }
  86
  87     $form->addField('case_type_id', array('context' => 'create', 'entity' => 'Case'));
  88
  89     // timeline
  90     $form->addYesNo('is_reset_timeline', ts('Reset Case Timeline?'), NULL, TRUE);
  91     $form->add('datepicker', 'reset_date_time', ts('Reset Start Date'), NULL, FALSE, ['allowClear' => FALSE]);
  92   }
  93
  94   /**
  95    * Global validation rules for the form.
  96    *
  97    * @param array $values
  98    *   Posted values of the form.
  99    *
 100    * @param $files
 101    * @param CRM_Core_Form $form
 102    *
 103    * @return array
 104    *   list of errors to be posted back to the form
 105    */
 106   public static function formRule($values, $files, $form) {
 107     return TRUE;
 108   }
 109
 110   /**
 111    * Process the form submission.
 112    *
 113    *
 114    * @param CRM_Core_Form $form
 115    * @param array $params
 116    */
 117   public static function beginPostProcess(&$form, &$params) {
 118     if ($form->_context == 'case') {
 119       $params['id'] = $form->_id;
 120     }
 121
 122     if (CRM_Utils_Array::value('is_reset_timeline', $params) == 0) {
 123       unset($params['reset_date_time']);
 124     }
 125   }
 126
 127   /**
 128    * Process the form submission.
 129    *
 130    *
 131    * @param CRM_Core_Form $form
 132    * @param array $params
 133    * @param $activity
 134    */
 135   public static function endPostProcess(&$form, &$params, $activity) {
 136     if (!$form->_caseId) {
 137       // always expecting a change, so case-id is a must.
 138       return;
 139     }
 140
 141     $caseTypes = CRM_Case_PseudoConstant::caseType('name');
 142     $allCaseTypes = CRM_Case_PseudoConstant::caseType('title', FALSE);
 143
 144     if (!empty($caseTypes[$params['case_type_id']])) {
 145       $caseType = $caseTypes[$params['case_type_id']];
 146     }
 147
 148     if (!$form->_currentlyViewedContactId ||
 149       !$form->_currentUserId ||
 150       !$params['case_type_id'] ||
 151       !$caseType
 152     ) {
 153       CRM_Core_Error::fatal('Required parameter missing for ChangeCaseType - end post processing');
 154     }
 155
 156     $params['status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
 157     $activity->status_id = $params['status_id'];
 158     $params['priority_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Normal');
 159     $activity->priority_id = $params['priority_id'];
 160
 161     if ($activity->subject == 'null') {
 162       $activity->subject = ts('Case type changed from %1 to %2',
 163         array(
 164           1 => CRM_Utils_Array::value($form->_defaults['case_type_id'], $allCaseTypes),
 165           2 => CRM_Utils_Array::value($params['case_type_id'], $allCaseTypes),
 166         )
 167       );
 168       $activity->save();
 169     }
 170
 171     // 1. initiate xml processor
 172     $xmlProcessor = new CRM_Case_XMLProcessor_Process();
 173     $caseId = CRM_Utils_Array::first($form->_caseId);
 174     $xmlProcessorParams = array(
 175       'clientID' => $form->_currentlyViewedContactId,
 176       'creatorID' => $form->_currentUserId,
 177       'standardTimeline' => 1,
 178       'activityTypeName' => 'Change Case Type',
 179       'activity_date_time' => CRM_Utils_Array::value('reset_date_time', $params),
 180       'caseID' => $caseId,
 181       'resetTimeline' => CRM_Utils_Array::value('is_reset_timeline', $params),
 182     );
 183
 184     $xmlProcessor->run($caseType, $xmlProcessorParams);
 185     // status msg
 186     $params['statusMsg'] = ts('Case Type changed successfully.');
 187   }
 188
 189 }