CRM/Case/Form/Case.php

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