Skip to content

Commit

Permalink
Add batch update via profile for cases
Browse files Browse the repository at this point in the history
  • Loading branch information
@mattwire
mattwire committed Dec 14, 2017
1 parent 03b9e33 commit 04d0351
Show file tree
Hide file tree
Showing 8 changed files with 557 additions and 5 deletions.
265 changes: 265 additions & 0 deletions CRM/Case/Form/Task/Batch.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,265 @@
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2017 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/

/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2017
* $Id$
*
*/

/**
* This class provides the functionality for batch profile update for cases
*/
class CRM_Case_Form_Task_Batch extends CRM_Case_Form_Task {

/**
* The title of the group.
*
* @var string
*/
protected $_title;

/**
* Maximum profile fields that will be displayed.
*/
protected $_maxFields = 9;

/**
* Variable to store redirect path.
*/
protected $_userContext;

/**
* Build all the data structures needed to build the form.
*
* @return void
*/
public function preProcess() {
// initialize the task and row fields
parent::preProcess();

//get the contact read only fields to display.
$readOnlyFields = array_merge(array('sort_name' => ts('Name')),
CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
'contact_autocomplete_options',
TRUE, NULL, FALSE, 'name', TRUE
)
);
//get the read only field data.
$returnProperties = array_fill_keys(array_keys($readOnlyFields), 1);
$contactDetails = CRM_Contact_BAO_Contact_Utils::contactDetails($this->_caseIds,
'CiviCase', $returnProperties
);

$this->assign('contactDetails', $contactDetails);
$this->assign('readOnlyFields', $readOnlyFields);
}

/**
* Build the form object.
*
*
* @return void
*/
public function buildQuickForm() {
$ufGroupId = $this->get('ufGroupId');

if (!$ufGroupId) {
CRM_Core_Error::fatal('ufGroupId is missing');
}
$this->_title = ts('Update multiple cases') . ' - ' . CRM_Core_BAO_UFGroup::getTitle($ufGroupId);
CRM_Utils_System::setTitle($this->_title);

$this->addDefaultButtons(ts('Save'));
$this->_fields = array();
$this->_fields = CRM_Core_BAO_UFGroup::getFields($ufGroupId, FALSE, CRM_Core_Action::VIEW);

// remove file type field and then limit fields
$suppressFields = FALSE;
$removehtmlTypes = array('File');
foreach ($this->_fields as $name => $field) {
if ($cfID = CRM_Core_BAO_CustomField::getKeyID($name) &&
in_array($this->_fields[$name]['html_type'], $removehtmlTypes)
) {
$suppressFields = TRUE;
unset($this->_fields[$name]);
}

//fix to reduce size as we are using this field in grid
if (is_array($field['attributes']) && !empty($this->_fields[$name]['attributes']['size']) && $this->_fields[$name]['attributes']['size'] > 19) {
//shrink class to "form-text-medium"
$this->_fields[$name]['attributes']['size'] = 19;
}
}

$this->_fields = array_slice($this->_fields, 0, $this->_maxFields);

$this->addButtons(array(
array(
'type' => 'submit',
'name' => ts('Update Case(s)'),
'isDefault' => TRUE,
),
array(
'type' => 'cancel',
'name' => ts('Cancel'),
),
));

$this->assign('profileTitle', $this->_title);
$this->assign('componentIds', $this->_caseIds);

$customFields = CRM_Core_BAO_CustomField::getFields('Case');
foreach ($this->_caseIds as $caseId) {
$typeId = CRM_Core_DAO::getFieldValue("CRM_Case_DAO_Case", $caseId, 'case_type_id');
foreach ($this->_fields as $name => $field) {
if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) {
$customValue = CRM_Utils_Array::value($customFieldID, $customFields);
$entityColumnValue = array();
if (!empty($customValue['extends_entity_column_value'])) {
$entityColumnValue = explode(CRM_Core_DAO::VALUE_SEPARATOR,
$customValue['extends_entity_column_value']
);
}
if ((CRM_Utils_Array::value($typeId, $entityColumnValue)) ||
CRM_Utils_System::isNull($entityColumnValue[$typeId])
) {
CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $caseId);
}
}
else {
// handle non custom fields
CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $caseId);
}
}
}

$this->assign('fields', $this->_fields);

// don't set the status message when form is submitted.
$buttonName = $this->controller->getButtonName('submit');

if ($suppressFields && $buttonName != '_qf_Batch_next') {
CRM_Core_Session::setStatus(ts("File type field(s) in the selected profile are not supported for Update multiple cases."), ts('Unsupported Field Type'), 'error');
}

$this->addDefaultButtons(ts('Update Cases'));
}

/**
* Set default values for the form.
*
*
* @return void
*/
public function setDefaultValues() {
if (empty($this->_fields)) {
return;
}

$defaults = array();
foreach ($this->_caseIds as $caseId) {
CRM_Core_BAO_UFGroup::setProfileDefaults(NULL, $this->_fields, $defaults, FALSE, $caseId, 'Case');
}

return $defaults;
}

/**
* Process the form after the input has been submitted and validated.
*
*
* @return void
*/
public function postProcess() {
$params = $this->exportValues();
$dates = array(
'case_created_date',
'case_start_date',
'case_end_date',
'case_modified_date',
);
if (isset($params['field'])) {
$customFields = array();
foreach ($params['field'] as $key => $value) {
$value['id'] = $key;

if (!empty($value['case_type'])) {
$caseTypeId = $value['case_type_id'] = $value['case_type'][1];
}

unset($value['case_type']);

//Get the case status
$value['status_id'] = (CRM_Utils_Array::value('case_status', $value)) ? $value['case_status'] : CRM_Core_DAO::getFieldValue('CRM_Case_DAO_Case', $key, 'status_id');
unset($value['case_status']);
foreach ($dates as $val) {
if (isset($value[$val])) {
$value[$val] = CRM_Utils_Date::processDate($value[$val]);
}
}
if (empty($customFields)) {
if (empty($value['case_type_id'])) {
$caseTypeId = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_Case', $key, 'case_type_id');
}

// case type custom data
$customFields = CRM_Core_BAO_CustomField::getFields('Case', FALSE, FALSE, $caseTypeId);

$customFields = CRM_Utils_Array::crmArrayMerge($customFields,
CRM_Core_BAO_CustomField::getFields('Case',
FALSE, FALSE, NULL, NULL, TRUE
)
);
}
//check for custom data
$value['custom'] = CRM_Core_BAO_CustomField::postProcess($params['field'][$key],
$key,
'Case',
$caseTypeId
);

$case = CRM_Case_BAO_Case::add($value);

// add custom field values
if (!empty($value['custom']) &&
is_array($value['custom'])
) {
CRM_Core_BAO_CustomValueTable::store($value['custom'], 'civicrm_case', $case->id);
}
}

CRM_Core_Session::setStatus(ts("Your updates have been saved."), ts('Saved'), 'success');
}
else {
CRM_Core_Session::setStatus(ts("No updates have been saved."), ts('Not Saved'), 'alert');
}
}

}
Loading

0 comments on commit 04d0351

Please sign in to comment.