CRM/Case/Form/Activity/ChangeCaseStatus.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for OpenCase Activity
  38  *
  39  */
  40 class CRM_Case_Form_Activity_ChangeCaseStatus {
  41
  42   static function preProcess(&$form) {
  43     if (!isset($form->_caseId)) {
  44       CRM_Core_Error::fatal(ts('Case Id not found.'));
  45     }
  46   }
  47
  48   /**
  49    * This function sets the default values for the form. For edit/view mode
  50    * the default values are retrieved from the database
  51    *
  52    * @access public
  53    *
  54    * @return void
  55    */
  56   static function setDefaultValues(&$form) {
  57     $defaults = array();
  58     // Retrieve current case status
  59     $defaults['case_status_id'] = $form->_defaultCaseStatus;
  60
  61     return $defaults;
  62   }
  63
  64   static function buildQuickForm(&$form) {
  65     $form->removeElement('status_id');
  66     $form->removeElement('priority_id');
  67
  68     $form->_caseStatus = CRM_Case_PseudoConstant::caseStatus();
  69
  70     foreach ($form->_caseId as $key => $val) {
  71       $form->_oldCaseStatus[] = $form->_defaultCaseStatus[] = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_Case', $val, 'status_id');
  72     }
  73
  74     foreach ($form->_defaultCaseStatus as $keydefault => $valdefault) {
  75       if (!array_key_exists($valdefault, $form->_caseStatus)) {
  76         $form->_caseStatus[$valdefault] = CRM_Core_OptionGroup::getLabel('case_status',
  77           $valdefault,
  78           FALSE
  79         );
  80       }
  81     }
  82     $element = $form->add('select', 'case_status_id', ts('Case Status'),
  83       $form->_caseStatus, TRUE
  84     );
  85     // check if the case status id passed in url is a valid one, set as default and freeze
  86     if (CRM_Utils_Request::retrieve('case_status_id', 'Positive', $form)) {
  87       $caseStatusId = CRM_Utils_Request::retrieve('case_status_id', 'Positive', $form);
  88       $caseStatus = CRM_Case_PseudoConstant::caseStatus();
  89       $form->_defaultCaseStatus = array_key_exists($caseStatusId, $caseStatus) ? $caseStatusId : NULL;
  90       $element->freeze();
  91     }
  92   }
  93
  94   /**
  95    * global validation rules for the form
  96    *
  97    * @param array $values posted values of the form
  98    *
  99    * @return array list of errors to be posted back to the form
 100    * @static
 101    * @access public
 102    */
 103   static function formRule($values, $files, $form) {
 104     return TRUE;
 105   }
 106
 107   /**
 108    * Function to process the form
 109    *
 110    * @access public
 111    *
 112    * @return void
 113    */
 114   static function beginPostProcess(&$form, &$params) {
 115     $params['id'] = CRM_Utils_Array::value('case_id', $params);
 116   }
 117
 118   /**
 119    * Function to process the form
 120    *
 121    * @access public
 122    *
 123    * @return void
 124    */
 125   static function endPostProcess(&$form, &$params, $activity) {
 126     $groupingValues = CRM_Core_OptionGroup::values('case_status', FALSE, TRUE, FALSE, NULL, 'value');
 127
 128     // Set case end_date if we're closing the case. Clear end_date if we're (re)opening it.
 129     if (CRM_Utils_Array::value($params['case_status_id'], $groupingValues) == 'Closed' && !empty($params['activity_date_time'])) {
 130       $params['end_date'] = $params['activity_date_time'];
 131
 132       // End case-specific relationships (roles)
 133       foreach ($params['target_contact_id'] as $cid) {
 134         $rels = CRM_Case_BAO_Case::getCaseRoles($cid, $params['case_id']);
 135         // FIXME: Is there an existing function to close a relationship?
 136         $query = 'UPDATE civicrm_relationship SET end_date=%2 WHERE id=%1';
 137         foreach ($rels as $relId => $relData) {
 138           $relParams = array(1 => array($relId, 'Integer'),
 139             2 => array($params['end_date'], 'Timestamp'),
 140           );
 141           CRM_Core_DAO::executeQuery($query, $relParams);
 142         }
 143       }
 144     }
 145     elseif (CRM_Utils_Array::value($params['case_status_id'], $groupingValues) == 'Opened') {
 146       $params['end_date'] = "null";
 147
 148       // Reopen case-specific relationships (roles)
 149       foreach ($params['target_contact_id'] as $cid) {
 150         $rels = CRM_Case_BAO_Case::getCaseRoles($cid, $params['case_id']);
 151         // FIXME: Is there an existing function?
 152         $query = 'UPDATE civicrm_relationship SET end_date=NULL WHERE id=%1';
 153         foreach ($rels as $relId => $relData) {
 154           $relParams = array(1 => array($relId, 'Integer'));
 155           CRM_Core_DAO::executeQuery($query, $relParams);
 156         }
 157       }
 158     }
 159     $params['status_id'] = CRM_Core_OptionGroup::getValue('activity_status', 'Completed', 'name');
 160     $activity->status_id = $params['status_id'];
 161     $params['priority_id'] = CRM_Core_OptionGroup::getValue('priority', 'Normal', 'name');
 162     $activity->priority_id = $params['priority_id'];
 163
 164     foreach ($form->_oldCaseStatus as $statuskey => $statusval ) {
 165       if ($activity->subject == 'null') {
 166         $activity->subject = ts('Case status changed from %1 to %2', array(
 167             1 => CRM_Utils_Array::value($statusval, $form->_caseStatus),
 168             2 => CRM_Utils_Array::value($params['case_status_id'], $form->_caseStatus)
 169           )
 170         );
 171         $activity->save();
 172       }
 173     }
 174
 175     // FIXME: does this do anything ?
 176     $params['statusMsg'] = ts('Case Status changed successfully.');
 177   }
 178 }
 179