3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This class generates form components for case activity
40 class CRM_Case_Form_Case
extends CRM_Core_Form
{
47 public $_context = 'case';
52 public $_caseId = NULL;
57 public $_currentlyViewedContactId = NULL;
62 public $_activityTypeFile = NULL;
65 * logged in contact Id
67 public $_currentUserId = NULL;
72 public $_activityTypeId = NULL;
77 public $_activityId = NULL;
87 public $_caseTypeId = NULL;
90 * Function to build the form
95 function preProcess() {
96 $this->_cdType
= CRM_Utils_Array
::value('type', $_GET);
97 $this->assign('cdType', FALSE);
99 $this->assign('cdType', TRUE);
100 return CRM_Custom_Form_CustomData
::preProcess($this);
103 $this->_caseId
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
105 $this->_currentlyViewedContactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
107 if ($this->_action
& CRM_Core_Action
::ADD
&& !$this->_currentlyViewedContactId
) {
108 // check for add contacts permissions
109 if (!CRM_Core_Permission
::check('add contacts')) {
110 CRM_Utils_System
::permissionDenied();
116 if (!CRM_Core_Permission
::checkActionPermission('CiviCase', $this->_action
)) {
117 CRM_Core_Error
::fatal(ts('You do not have permission to access this page'));
120 if ($this->_action
& CRM_Core_Action
::DELETE ||
$this->_action
& CRM_Core_Action
::RENEW
) {
124 if (!$this->_caseId
) {
125 $caseAttributes = array('case_type' => CRM_Case_PseudoConstant
::caseType(),
126 'case_status' => CRM_Case_PseudoConstant
::caseStatus(),
127 'encounter_medium' => CRM_Case_PseudoConstant
::encounterMedium(),
130 foreach ($caseAttributes as $key => $values) {
131 if (empty($values)) {
132 CRM_Core_Error
::fatal(ts('You do not have any active %1',
133 array(1 => str_replace('_', ' ', $key))
140 if ($this->_action
& CRM_Core_Action
::ADD
) {
141 $this->_activityTypeId
= CRM_Core_OptionGroup
::getValue('activity_type',
145 if (!$this->_activityTypeId
) {
146 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.'));
150 //check for case permissions.
151 if (!CRM_Case_BAO_Case
::accessCiviCase()) {
152 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
154 if (($this->_action
& CRM_Core_Action
::ADD
) &&
155 (!CRM_Core_Permission
::check('access all cases and activities') &&
156 !CRM_Core_Permission
::check('add cases')
159 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
162 if ($this->_activityTypeFile
=
163 CRM_Activity_BAO_Activity
::getFileForActivityTypeId($this->_activityTypeId
,
167 $this->assign('activityTypeFile', $this->_activityTypeFile
);
170 $details = CRM_Case_PseudoConstant
::caseActivityType(FALSE);
172 CRM_Utils_System
::setTitle($details[$this->_activityTypeId
]['label']);
173 $this->assign('activityType', $details[$this->_activityTypeId
]['label']);
174 $this->assign('activityTypeDescription', $details[$this->_activityTypeId
]['description']);
176 if (isset($this->_currentlyViewedContactId
)) {
177 $contact = new CRM_Contact_DAO_Contact();
178 $contact->id
= $this->_currentlyViewedContactId
;
179 if (!$contact->find(TRUE)) {
180 CRM_Core_Error
::statusBounce(ts('Client contact does not exist: %1', array(1 => $this->_currentlyViewedContactId
)));
182 $this->assign('clientName', $contact->display_name
);
186 $session = CRM_Core_Session
::singleton();
187 $this->_currentUserId
= $session->get('userID');
189 //when custom data is included in this page
190 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $this->_activityTypeId
, 1, 'Activity');
191 $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}";
192 $className::preProcess($this);
193 $activityGroupTree = $this->_groupTree
;
195 // for case custom fields to populate with defaults
196 if (!empty($_POST['hidden_custom'])) {
197 CRM_Custom_Form_CustomData
::preProcess($this);
198 CRM_Custom_Form_CustomData
::buildQuickForm($this);
201 // so that grouptree is not populated with case fields, since the grouptree is used
202 // for populating activity custom fields.
203 $this->_groupTree
= $activityGroupTree;
207 * This function sets the default values for the form. For edit/view mode
208 * the default values are retrieved from the database
214 function setDefaultValues() {
215 if ($this->_action
& CRM_Core_Action
::DELETE ||
$this->_action
& CRM_Core_Action
::RENEW ||
$this->_cdType
) {
218 $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}";
219 $defaults = $className::setDefaultValues($this);
220 $defaults = array_merge($defaults, CRM_Custom_Form_CustomData
::setDefaultValues($this));
224 public function buildQuickForm() {
225 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
226 $isMultiClient = $xmlProcessorProcess->getAllowMultipleCaseClients();
227 $this->assign('multiClient', $isMultiClient);
229 if ($this->_action
& CRM_Core_Action
::DELETE ||
$this->_action
& CRM_Core_Action
::RENEW
) {
231 if ($this->_action
& CRM_Core_Action
::RENEW
) {
234 $this->addButtons(array(
238 'spacing' => ' ',
243 'name' => ts('Cancel'),
250 if ($this->_cdType
) {
251 return CRM_Custom_Form_CustomData
::buildQuickForm($this);
253 //need to assign custom data type and subtype to the template
254 $this->assign('customDataType', 'Case');
256 CRM_Custom_Form_CustomData
::buildQuickForm($this);
257 // we don't want to show button on top of custom form
258 $this->assign('noPreCustomButton', TRUE);
260 $s = CRM_Core_DAO
::getAttribute('CRM_Activity_DAO_Activity', 'subject');
264 $this->add('text', 'activity_subject', ts('Subject'),
265 array_merge($s, array(
266 'maxlength' => '128')), TRUE
269 $tags = CRM_Core_BAO_Tag
::getTags('civicrm_case');
271 $this->add('select', 'tag', ts('Select Tags'), $tags, FALSE,
272 array('id' => 'tags', 'multiple' => 'multiple', 'class' => 'crm-select2')
277 $parentNames = CRM_Core_BAO_Tag
::getTagSet('civicrm_case');
278 CRM_Core_Form_Tag
::buildQuickForm($this, $parentNames, 'civicrm_case', NULL, TRUE, TRUE);
280 $this->addButtons(array(
283 'name' => ts('Save'),
284 'spacing' => ' ',
289 'name' => ts('Cancel'),
294 $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}";
295 $className::buildQuickForm($this);
299 * Add local and global form rules
305 function addRules() {
306 if ($this->_action
& CRM_Core_Action
::DELETE ||
$this->_action
& CRM_Core_Action
::RENEW ||
$this->_cdType
) {
309 $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}";
310 $this->addFormRule(array($className, 'formRule'), $this);
311 $this->addFormRule(array('CRM_Case_Form_Case', 'formRule'), $this);
315 * global validation rules for the form
317 * @param array $values posted values of the form
319 * @return array list of errors to be posted back to the form
323 static function formRule($values, $files, $form) {
328 * Function to process the form
334 public function postProcess() {
335 $transaction = new CRM_Core_Transaction();
337 // check if dedupe button, if so return.
338 $buttonName = $this->controller
->getButtonName();
339 if (isset($this->_dedupeButtonName
) && $buttonName == $this->_dedupeButtonName
) {
343 if ($this->_action
& CRM_Core_Action
::DELETE
) {
345 $caseDelete = CRM_Case_BAO_Case
::deleteCase($this->_caseId
, TRUE);
347 $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 />');
349 CRM_Core_Session
::setStatus($statusMsg, ts('Case Deleted'), 'success');
353 if ($this->_action
& CRM_Core_Action
::RENEW
) {
355 $caseRestore = CRM_Case_BAO_Case
::restoreCase($this->_caseId
);
357 $statusMsg = ts('The selected case has been restored.<br />');
359 CRM_Core_Session
::setStatus($statusMsg, ts('Restored'), 'success');
362 // store the submitted values in an array
363 $params = $this->controller
->exportValues($this->_name
);
364 $params['now'] = date("Ymd");
367 // 1. call begin post process
368 if ($this->_activityTypeFile
) {
369 $className = "CRM_Case_Form_Activity_{$this->_activityTypeFile}";
370 $className::beginPostProcess($this, $params );
373 if (!empty($params['hidden_custom']) &&
374 !isset($params['custom'])
376 $customFields = array();
377 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess(
385 // 2. create/edit case
386 if (!empty($params['case_type_id'])) {
387 $caseType = CRM_Case_PseudoConstant
::caseType('name');
388 $params['case_type'] = $caseType[$params['case_type_id']];
389 $params['subject'] = $params['activity_subject'];
390 $params['case_type_id'] = CRM_Core_DAO
::VALUE_SEPARATOR
. $params['case_type_id'] . CRM_Core_DAO
::VALUE_SEPARATOR
;
392 $caseObj = CRM_Case_BAO_Case
::create($params);
393 $params['case_id'] = $caseObj->id
;
394 // unset any ids, custom data
395 unset($params['id'], $params['custom']);
397 // add tags if exists
398 $tagParams = array();
399 if (!empty($params['tag'])) {
400 $tagParams = array();
401 foreach ($params['tag'] as $tag) {
402 $tagParams[$tag] = 1;
405 CRM_Core_BAO_EntityTag
::create($tagParams, 'civicrm_case', $caseObj->id
);
408 if (isset($params['case_taglist']) && !empty($params['case_taglist'])) {
409 CRM_Core_Form_Tag
::postProcess($params['case_taglist'], $caseObj->id
, 'civicrm_case', $this);
413 $url = CRM_Utils_System
::url('civicrm/contact/view/case',
414 "reset=1&action=view&cid={$this->_currentlyViewedContactId}&id={$caseObj->id}"
416 $session = CRM_Core_Session
::singleton();
417 $session->pushUserContext($url);
419 // 3. format activity custom data
420 if (!empty($params['hidden_custom'])) {
421 $customFields = CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE, $this->_activityTypeId
);
422 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
423 CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE,
427 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
434 // 4. call end post process
435 if ($this->_activityTypeFile
) {
436 $className::endPostProcess($this, $params );
439 // 5. auto populate activites
442 CRM_Core_Session
::setStatus($params['statusMsg'], ts('Saved'), 'success');