Skip to content
Snippets Groups Projects
Unverified Commit 4515d9aa authored by Eileen McNaughton's avatar Eileen McNaughton Committed by GitHub
Browse files

Merge pull request #19735 from demeritcowboy/case-custom-origblank 

#2019 - Changing a case custom field from blank to something doesn't show properly what changed
parents 29c1b153 68efd94e
Branches
Tags
No related merge requests found
Hide whitespace changes
Inline Side-by-side
CRM/Case/Form/CustomData.php
+ 1
− 1
View file @ 4515d9aa
......@@ -146,7 +146,7 @@ class CRM_Case_Form_CustomData extends CRM_Core_Form {
$formattedDetails = [];
foreach ($params as $customField => $newCustomValue) {
if (substr($customField, 0, 7) == 'custom_') {
if ($this->_defaults[$customField] == $newCustomValue) {
if (($this->_defaults[$customField] ?? '') === $newCustomValue) {
// Don't show values that did not change
continue;
}
......
api/v3/CustomValue.php
+ 4
− 3
View file @ 4515d9aa
......@@ -399,7 +399,7 @@ function _civicrm_api3_custom_value_getdisplayvalue_spec(&$spec) {
];
$spec['custom_field_value'] = [
'title' => 'Custom Field value',
'description' => 'Specify the value of the custom field to return as displayed value',
'description' => 'Specify the value of the custom field to return as displayed value, or omit to use the current value.',
'type' => CRM_Utils_Type::T_STRING,
'api.required' => 0,
];
......@@ -414,14 +414,15 @@ function _civicrm_api3_custom_value_getdisplayvalue_spec(&$spec) {
* @throws \CiviCRM_API3_Exception
*/
function civicrm_api3_custom_value_getdisplayvalue($params) {
if (empty($params['custom_field_value'])) {
// Null or missing means use the current db value, but treat '0', 0, and '' as legitimate values to look up.
if (($params['custom_field_value'] ?? NULL) === NULL) {
$params['custom_field_value'] = civicrm_api3('CustomValue', 'getsingle', [
'return' => ["custom_{$params['custom_field_id']}"],
'entity_id' => $params['entity_id'],
]);
$params['custom_field_value'] = $params['custom_field_value']['latest'];
}
$values[$params['custom_field_id']]['display'] = CRM_Core_BAO_CustomField::displayValue($params['custom_field_value'], $params['custom_field_id'], CRM_Utils_Array::value('entity_id', $params));
$values[$params['custom_field_id']]['display'] = CRM_Core_BAO_CustomField::displayValue($params['custom_field_value'], $params['custom_field_id'], $params['entity_id'] ?? NULL);
$values[$params['custom_field_id']]['raw'] = $params['custom_field_value'];
return civicrm_api3_create_success($values, $params, 'CustomValue', 'getdisplayvalue');
}
tests/phpunit/CRM/Case/Form/CustomDataTest.php 0 → 100644
+ 333
− 0
View file @ 4515d9aa
<?php
require_once 'CiviTest/CiviCaseTestCase.php';
/**
* Class CRM_Case_Form_CustomDataTest
* @group headless
*/
class CRM_Case_Form_CustomDataTest extends CiviCaseTestCase {
protected $custom_group;
public function setUp() {
parent::setUp();
$this->custom_group = $this->customGroupCreate(['extends' => 'Case']);
$this->custom_group = $this->custom_group['values'][$this->custom_group['id']];
}
/**
* Test that changes to custom fields on cases generate the correct details
* body for ChangeCustomData.
*
* @dataProvider customDataProvider
*
* @param array $input
* @param array $expected
*/
public function testChangeCustomDataFormattedDetails(array $input, array $expected) {
// set up custom field, with any overrides from input params
$custom_field = $this->callAPISuccess('custom_field', 'create', array_merge([
'custom_group_id' => $this->custom_group['id'],
'label' => 'What?',
'data_type' => 'String',
'html_type' => 'Text',
'is_active' => 1,
], $input['custom_field_params']));
$custom_field = $custom_field['values'][$custom_field['id']];
// set up case and set the custom field initial value
$client_id = $this->individualCreate([], 0, TRUE);
$caseObj = $this->createCase($client_id, $this->_loggedInUser);
if (isset($input['custom_field_oldvalue'])) {
$this->callAPISuccess('CustomValue', 'create', [
"custom_{$custom_field['id']}" => $input['custom_field_oldvalue'],
'entity_id' => $caseObj->id,
]);
}
// set up form
$form = $this->getFormObject('CRM_Case_Form_CustomData');
$form->set('groupID', $this->custom_group['id']);
$form->set('entityID', $caseObj->id);
$form->set('subType', $this->caseTypeId);
$form->set('cid', $client_id);
$form->preProcess();
// We need to do money conversion here because to do the creation above it
// needs to be in machine format, but then for the form stuff it needs to
// be in user format.
if (($input['custom_field_params']['data_type'] ?? '') === 'Money' && CRM_Core_I18n::singleton()->getLocale() !== 'en_US') {
$expected['string'] = $this->convertCurrency($expected['string']);
if (isset($input['custom_field_oldvalue'])) {
$input['custom_field_oldvalue'] = $this->convertCurrency($input['custom_field_oldvalue']);
}
$input['custom_field_newvalue'] = $this->convertCurrency($input['custom_field_newvalue']);
}
// Simulate an edit with formValues.
// The suffix is always going to be '1' since we created it above and it's
// the first entry in the custom_value_XX table. If it doesn't exist yet
// then our new entry will still be the first and will have suffix 1.
$custom_field_name = "custom_{$custom_field['id']}_1";
$formValues = [$custom_field_name => $input['custom_field_newvalue']];
// compute and compare
$output = $form->formatCustomDataChangesForDetail($formValues);
$this->assertEquals($expected['string'], $output);
}
/**
* Same as testChangeCustomDataFormattedDetails but in a different locale.
*
* @dataProvider customDataProvider
*
* @param array $input
* @param array $expected
*/
public function testChangeCustomDataFormattedDetailsLocale(array $input, array $expected) {
CRM_Core_I18n::singleton()->setLocale('it_IT');
CRM_Core_Config::singleton()->defaultCurrency = 'EUR';
CRM_Core_Config::singleton()->monetaryThousandSeparator = ' ';
CRM_Core_Config::singleton()->monetaryDecimalPoint = ',';
$this->testChangeCustomDataFormattedDetails($input, $expected);
CRM_Core_Config::singleton()->defaultCurrency = 'USD';
CRM_Core_Config::singleton()->monetaryThousandSeparator = ',';
CRM_Core_Config::singleton()->monetaryDecimalPoint = '.';
CRM_Core_I18n::singleton()->setLocale('en_US');
}
/**
* data provider for testChangeCustomDataFormattedDetails
*
* @return array
*/
public function customDataProvider(): array {
return [
0 => [
'input' => [
'custom_field_params' => [
'html_type' => 'Select',
'option_values' => [
[
'name' => 'Red',
'label' => 'Red',
'value' => '1',
'is_active' => 1,
'weight' => 1,
],
[
'name' => 'Green',
'label' => 'Green',
'value' => '2',
'is_active' => 1,
'weight' => 2,
],
],
],
'custom_field_oldvalue' => '1',
'custom_field_newvalue' => '2',
],
'expected' => [
'string' => 'What?: Red => Green',
],
],
1 => [
'input' => [
'custom_field_params' => [
'html_type' => 'Select',
'option_values' => [
[
'name' => 'Red',
'label' => 'Red',
'value' => '1',
'is_active' => 1,
'weight' => 1,
],
[
'name' => 'Green',
'label' => 'Green',
'value' => '2',
'is_active' => 1,
'weight' => 2,
],
],
],
'custom_field_oldvalue' => '',
'custom_field_newvalue' => '2',
],
'expected' => [
'string' => 'What?: => Green',
],
],
2 => [
'input' => [
'custom_field_params' => [
'html_type' => 'Select',
'option_values' => [
[
'name' => 'Red',
'label' => 'Red',
'value' => '1',
'is_active' => 1,
'weight' => 1,
],
[
'name' => 'Green',
'label' => 'Green',
'value' => '2',
'is_active' => 1,
'weight' => 2,
],
],
],
'custom_field_oldvalue' => '1',
'custom_field_newvalue' => '',
],
'expected' => [
'string' => 'What?: Red => ',
],
],
3 => [
'input' => [
'custom_field_params' => [
'html_type' => 'Select',
'option_values' => [
[
'name' => 'Red',
'label' => 'Red',
'value' => '1',
'is_active' => 1,
'weight' => 1,
],
[
'name' => 'Green',
'label' => 'Green',
'value' => '2',
'is_active' => 1,
'weight' => 2,
],
],
],
// Note no old value, simulating as if we already have existing cases, but just added the field definition now.
'custom_field_newvalue' => '2',
],
'expected' => [
'string' => 'What?: => Green',
],
],
4 => [
'input' => [
'custom_field_params' => [
'data_type' => 'Money',
],
'custom_field_oldvalue' => '1.23',
'custom_field_newvalue' => '2.34',
],
'expected' => [
'string' => 'What?: 1.23 => 2.34',
],
],
5 => [
'input' => [
'custom_field_params' => [
'data_type' => 'Money',
],
'custom_field_oldvalue' => '',
'custom_field_newvalue' => '2.34',
],
'expected' => [
'string' => 'What?: 0.00 => 2.34',
],
],
6 => [
'input' => [
'custom_field_params' => [
'data_type' => 'Money',
],
'custom_field_oldvalue' => '1.23',
'custom_field_newvalue' => '',
],
'expected' => [
'string' => 'What?: 1.23 => ',
],
],
7 => [
'input' => [
'custom_field_params' => [
'data_type' => 'Money',
],
'custom_field_newvalue' => '2.34',
],
'expected' => [
'string' => 'What?: => 2.34',
],
],
8 => [
'input' => [
'custom_field_params' => [],
'custom_field_oldvalue' => 'some text',
'custom_field_newvalue' => 'some new text',
],
'expected' => [
'string' => 'What?: some text => some new text',
],
],
9 => [
'input' => [
'custom_field_params' => [],
'custom_field_oldvalue' => '',
'custom_field_newvalue' => 'some new text',
],
'expected' => [
'string' => 'What?: => some new text',
],
],
10 => [
'input' => [
'custom_field_params' => [],
'custom_field_oldvalue' => 'some text',
'custom_field_newvalue' => '',
],
'expected' => [
'string' => 'What?: some text => ',
],
],
11 => [
'input' => [
'custom_field_params' => [],
'custom_field_newvalue' => 'some new text',
],
'expected' => [
'string' => 'What?: => some new text',
],
],
];
}
/**
* Convert to locale currency format for purposes of these tests
* @param string $input
* @return string
*/
private function convertCurrency(string $input): string {
$conversion_table = [
',' => CRM_Core_Config::singleton()->monetaryThousandSeparator,
'.' => CRM_Core_Config::singleton()->monetaryDecimalPoint,
];
return strtr($input, $conversion_table);
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment