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'] = array();
  65     list($defaults['reset_date_time'], $defaults['reset_date_time_time']) = CRM_Utils_Date::setDateDefaults(NULL, 'activityDateTime');
  66     $defaults['case_type_id'] = $form->_caseTypeId;
  67
  68     return $defaults;
  69   }
  70
  71   /**
  72    * @param CRM_Core_Form $form
  73    */
  74   public static function buildQuickForm(&$form) {
  75     $form->removeElement('status_id');
  76     $form->removeElement('priority_id');
  77
  78     $caseId = CRM_Utils_Array::first($form->_caseId);
  79     $form->_caseType = CRM_Case_BAO_Case::buildOptions('case_type_id', 'create');
  80     $form->_caseTypeId = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_Case',
  81       $caseId,
  82       'case_type_id'
  83     );
  84     if (!in_array($form->_caseTypeId, $form->_caseType)) {
  85       $form->_caseType[$form->_caseTypeId] = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $form->_caseTypeId, 'title');
  86     }
  87
  88     $form->addField('case_type_id', array('context' => 'create', 'entity' => 'Case'));
  89
  90     // timeline
  91     $form->addYesNo('is_reset_timeline', ts('Reset Case Timeline?'), NULL, TRUE, array('onclick' => "return showHideByValue('is_reset_timeline','','resetTimeline','table-row','radio',false);"));
  92     $form->addDateTime('reset_date_time', ts('Reset Start Date'), FALSE, array('formatType' => 'activityDateTime'));
  93   }
  94
  95   /**
  96    * Global validation rules for the form.
  97    *
  98    * @param array $values
  99    *   Posted values of the form.
 100    *
 101    * @param $files
 102    * @param CRM_Core_Form $form
 103    *
 104    * @return array
 105    *   list of errors to be posted back to the form
 106    */
 107   public static function formRule($values, $files, $form) {
 108     return TRUE;
 109   }
 110
 111   /**
 112    * Process the form submission.
 113    *
 114    *
 115    * @param CRM_Core_Form $form
 116    * @param array $params
 117    */
 118   public static function beginPostProcess(&$form, &$params) {
 119     if ($form->_context == 'case') {
 120       $params['id'] = $form->_id;
 121     }
 122
 123     if (CRM_Utils_Array::value('is_reset_timeline', $params) == 0) {
 124       unset($params['reset_date_time']);
 125     }
 126     else {
 127       // store the date with proper format
 128       $params['reset_date_time'] = CRM_Utils_Date::processDate($params['reset_date_time'], $params['reset_date_time_time']);
 129     }
 130   }
 131
 132   /**
 133    * Process the form submission.
 134    *
 135    *
 136    * @param CRM_Core_Form $form
 137    * @param array $params
 138    * @param $activity
 139    */
 140   public static function endPostProcess(&$form, &$params, $activity) {
 141     if (!$form->_caseId) {
 142       // always expecting a change, so case-id is a must.
 143       return;
 144     }
 145
 146     $caseTypes = CRM_Case_PseudoConstant::caseType('name');
 147     $allCaseTypes = CRM_Case_PseudoConstant::caseType('title', FALSE);
 148
 149     if (!empty($caseTypes[$params['case_type_id']])) {
 150       $caseType = $caseTypes[$params['case_type_id']];
 151     }
 152
 153     if (!$form->_currentlyViewedContactId ||
 154       !$form->_currentUserId ||
 155       !$params['case_type_id'] ||
 156       !$caseType
 157     ) {
 158       CRM_Core_Error::fatal('Required parameter missing for ChangeCaseType - end post processing');
 159     }
 160
 161     $params['status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
 162     $activity->status_id = $params['status_id'];
 163     $params['priority_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Normal');
 164     $activity->priority_id = $params['priority_id'];
 165
 166     if ($activity->subject == 'null') {
 167       $activity->subject = ts('Case type changed from %1 to %2',
 168         array(
 169           1 => CRM_Utils_Array::value($form->_defaults['case_type_id'], $allCaseTypes),
 170           2 => CRM_Utils_Array::value($params['case_type_id'], $allCaseTypes),
 171         )
 172       );
 173       $activity->save();
 174     }
 175
 176     // 1. initiate xml processor
 177     $xmlProcessor = new CRM_Case_XMLProcessor_Process();
 178     $caseId = CRM_Utils_Array::first($form->_caseId);
 179     $xmlProcessorParams = array(
 180       'clientID' => $form->_currentlyViewedContactId,
 181       'creatorID' => $form->_currentUserId,
 182       'standardTimeline' => 1,
 183       'activityTypeName' => 'Change Case Type',
 184       'activity_date_time' => CRM_Utils_Array::value('reset_date_time', $params),
 185       'caseID' => $caseId,
 186       'resetTimeline' => CRM_Utils_Array::value('is_reset_timeline', $params),
 187     );
 188
 189     $xmlProcessor->run($caseType, $xmlProcessorParams);
 190     // status msg
 191     $params['statusMsg'] = ts('Case Type changed successfully.');
 192   }
 193
 194 }