Skip to content

Commit

Permalink
Merge pull request #15781 from eileenmcnaughton/cont_search
Browse files Browse the repository at this point in the history 
dev/core#1374 Fix search formValue handling on contribution search
@seamuslee001
seamuslee001 authored Nov 9, 2019
2 parents 0f1268b + e9f5171 commit a4b70c3
Showing 4 changed files with 40 additions and 17 deletions.
2 changes: 1 addition & 1 deletion CRM/Contact/Form/Search/Advanced.php
View file
Original file line number Diff line number Diff line change
@@ -201,7 +201,7 @@ public function setDefaultValues() {
$this->_ssID = $this->get('ssID');
}

$defaults = array_merge($this->_formValues, [
$defaults = array_merge((array) $this->_formValues, [
'privacy_toggle' => 1,
'operator' => 'AND',
], $defaults);
25 changes: 13 additions & 12 deletions CRM/Contribute/Form/Search.php
View file
Original file line number Diff line number Diff line change
@@ -84,9 +84,7 @@ public function preProcess() {

$this->_done = FALSE;

$this->loadStandardSearchOptionsFromUrl();

$this->_formValues = $this->getFormValues();
parent::preProcess();

//membership ID
$memberShipId = CRM_Utils_Request::retrieve('memberId', 'Positive', $this);
@@ -98,10 +96,6 @@ public function preProcess() {
$this->_formValues['contribution_participant_id'] = $participantId;
}

if ($this->_force) {
$this->handleForcedSearch();
}

$sortID = NULL;
if ($this->get(CRM_Utils_Sort::SORT_ID)) {
$sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
@@ -277,10 +271,12 @@ public function postProcess() {
$this->_done = TRUE;

$this->setFormValues();
// @todo - stop changing formValues - respect submitted form values, change a working array.
$this->fixFormValues();

// We don't show test records in summaries or dashboards
if (empty($this->_formValues['contribution_test']) && $this->_force && !empty($this->_context) && $this->_context == 'dashboard') {
// @todo - stop changing formValues - respect submitted form values, change a working array.
$this->_formValues["contribution_test"] = 0;
}

@@ -289,11 +285,11 @@ public function postProcess() {
'contribution_amount_high',
] as $f) {
if (isset($this->_formValues[$f])) {
// @todo - stop changing formValues - respect submitted form values, change a working array.
$this->_formValues[$f] = CRM_Utils_Rule::cleanMoney($this->_formValues[$f]);
}
}

$config = CRM_Core_Config::singleton();
if (!empty($_POST)) {
$specialParams = [
'financial_type_id',
@@ -306,40 +302,47 @@ public function postProcess() {
'payment_instrument_id',
'contribution_batch_id',
];
// @todo - stop changing formValues - respect submitted form values, change a working array.
CRM_Contact_BAO_Query::processSpecialFormValue($this->_formValues, $specialParams);

// @todo - stop changing formValues - respect submitted form values, change a working array.
$tags = CRM_Utils_Array::value('contact_tags', $this->_formValues);
if ($tags && !is_array($tags)) {
// @todo - stop changing formValues - respect submitted form values, change a working array.
unset($this->_formValues['contact_tags']);
$this->_formValues['contact_tags'][$tags] = 1;
}

if ($tags && is_array($tags)) {
unset($this->_formValues['contact_tags']);
foreach ($tags as $notImportant => $tagID) {
// @todo - stop changing formValues - respect submitted form values, change a working array.
$this->_formValues['contact_tags'][$tagID] = 1;
}
}

$group = CRM_Utils_Array::value('group', $this->_formValues);
if ($group && !is_array($group)) {
// @todo - stop changing formValues - respect submitted form values, change a working array.
unset($this->_formValues['group']);
$this->_formValues['group'][$group] = 1;
}

if ($group && is_array($group)) {
unset($this->_formValues['group']);
foreach ($group as $groupID) {
// @todo - stop changing formValues - respect submitted form values, change a working array.
$this->_formValues['group'][$groupID] = 1;
}
}
}

// @todo - stop changing formValues - respect submitted form values, change a working array.
CRM_Core_BAO_CustomValue::fixCustomFieldValue($this->_formValues);

// @todo - stop changing formValues - respect submitted form values, change a working array.
$this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);

$this->set('formValues', $this->_formValues);
$this->set('queryParams', $this->_queryParams);

$buttonName = $this->controller->getButtonName();
@@ -360,6 +363,7 @@ public function postProcess() {
);
}

// @todo - stop changing formValues - respect submitted form values, change a working array.
$this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
$selector = new CRM_Contribute_Selector_Search($this->_queryParams,
$this->_action,
@@ -456,9 +460,6 @@ public function fixFormValues() {
if ($contribPageId) {
$this->_formValues['contribution_page_id'] = $contribPageId;
}

//give values to default.
$this->_defaults = $this->_formValues;
}

/**
21 changes: 20 additions & 1 deletion CRM/Core/Form/Search.php
View file
Original file line number Diff line number Diff line change
@@ -124,6 +124,20 @@ public function addSearchFieldMetadata($searchFieldMetadata) {
$this->searchFieldMetadata = array_merge($this->searchFieldMetadata, $searchFieldMetadata);
}

/**
* Prepare for search by loading options from the url, handling force searches, retrieving form values.
*
* @throws \CRM_Core_Exception
* @throws \CiviCRM_API3_Exception
*/
public function preProcess() {
$this->loadStandardSearchOptionsFromUrl();
if ($this->_force) {
$this->handleForcedSearch();
}
$this->_formValues = $this->getFormValues();
}

/**
* This virtual function is used to set the default values of various form elements.
*
@@ -132,7 +146,10 @@ public function addSearchFieldMetadata($searchFieldMetadata) {
* @throws \CRM_Core_Exception
*/
public function setDefaultValues() {
$defaults = (array) $this->_formValues;
// Use the form values stored to the form. Ideally 'formValues'
// would remain 'pure' & another array would be wrangled.
// We don't do that - so we want the version of formValues stored early on.
$defaults = (array) $this->get('formValues');
foreach (array_keys($this->getSearchFieldMetadata()) as $entity) {
$defaults = array_merge($this->getEntityDefaults($entity), $defaults);
}
@@ -146,6 +163,7 @@ public function setDefaultValues() {
*/
protected function setFormValues() {
$this->_formValues = $this->getFormValues();
$this->set('formValues', $this->_formValues);
$this->convertTextStringsToUseLikeOperator();
}

@@ -508,6 +526,7 @@ protected function setSearchMetadata() {}
*/
protected function handleForcedSearch() {
$this->setSearchMetadata();
$this->addContactSearchFields();
$this->postProcess();
$this->set('force', 0);
}
9 changes: 6 additions & 3 deletions tests/phpunit/CRM/Contact/BAO/SavedSearchTest.php
View file
Original file line number Diff line number Diff line change
@@ -58,11 +58,13 @@ protected function tearDown() {

/**
* Test setDefaults for privacy radio buttons.
*
* @throws \Exception
*/
public function testDefaultValues() {
$sg = new CRM_Contact_Form_Search_Advanced();
$sg->controller = new CRM_Core_Controller();
$sg->_formValues = [
$formValues = [
'group_search_selected' => 'group',
'privacy_options' => ['do_not_email'],
'privacy_operator' => 'OR',
@@ -71,14 +73,15 @@ public function testDefaultValues() {
'component_mode' => 1,
];
CRM_Core_DAO::executeQuery(
"INSERT INTO civicrm_saved_search (form_values) VALUES('" . serialize($sg->_formValues) . "')"
"INSERT INTO civicrm_saved_search (form_values) VALUES('" . serialize($formValues) . "')"
);
$ssID = CRM_Core_DAO::singleValueQuery('SELECT LAST_INSERT_ID()');
$sg->set('ssID', $ssID);
$sg->set('formValues', $formValues);

$defaults = $sg->setDefaultValues();

$this->checkArrayEquals($defaults, $sg->_formValues);
$this->checkArrayEquals($defaults, $formValues);
}

/**

0 comments on commit a4b70c3

Please sign in to comment.