From 86a0d21ecdbb8f2fcad5e7aa58ed24143ea9ea0d Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Sat, 22 Oct 2016 11:19:17 -0400 Subject: [PATCH] Cleanup BAO_Query classes --- CRM/Activity/BAO/Query.php | 30 +------- CRM/Case/BAO/Query.php | 29 +------- CRM/Contact/Form/Search/Criteria.php | 37 +--------- CRM/Contribute/BAO/ContributionRecur.php | 20 +---- CRM/Contribute/BAO/Query.php | 30 +------- CRM/Core/BAO/Query.php | 74 +++++++++++++++++++ CRM/Event/BAO/Query.php | 38 +--------- CRM/Grant/BAO/Query.php | 43 +---------- CRM/Member/BAO/Query.php | 30 +------- CRM/Pledge/BAO/Query.php | 37 +--------- .../CRM/Contribute/Form/Search/Common.tpl | 4 +- .../Form/Search/ContributionRecur.tpl | 4 +- 12 files changed, 100 insertions(+), 276 deletions(-) create mode 100644 CRM/Core/BAO/Query.php diff --git a/CRM/Activity/BAO/Query.php b/CRM/Activity/BAO/Query.php index b42e610c3e..737630b4da 100644 --- a/CRM/Activity/BAO/Query.php +++ b/CRM/Activity/BAO/Query.php @@ -394,22 +394,12 @@ class CRM_Activity_BAO_Query { return $from; } - /** - * Getter for the qill object. - * - * @return string - */ - public function qill() { - return (isset($this->_qill)) ? $this->_qill : ""; - } - /** * Add all the elements shared between case activity search and advanced search. * * @param CRM_Core_Form $form */ public static function buildSearchForm(&$form) { - $activityOptions = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE); $form->addSelect('activity_type_id', array('entity' => 'activity', 'label' => ts('Activity Type(s)'), 'multiple' => 'multiple', 'option_url' => NULL, 'placeholder' => ts('- any -')) ); @@ -457,23 +447,8 @@ class CRM_Activity_BAO_Query { array('class' => 'crm-select2') ); } - $extends = array('Activity'); - $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $extends); - if ($groupDetails) { - $form->assign('activityGroupTree', $groupDetails); - foreach ($groupDetails as $group) { - foreach ($group['fields'] as $field) { - $fieldId = $field['id']; - $elementName = 'custom_' . $fieldId; - if ($field['data_type'] == 'Date' && $field['is_search_range']) { - CRM_Core_Form_Date::buildDateRange($form, $elementName, 1, '_from', '_to', ts('From:'), FALSE); - } - else { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); - } - } - } - } + + CRM_Core_BAO_Query::addCustomFormFields($form, array('Activity')); CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'activity_campaign_id'); @@ -491,7 +466,6 @@ class CRM_Activity_BAO_Query { $resultOptions = array(); foreach ($optionGroups as $gid => $name) { if ($name) { - $value = array(); $value = CRM_Core_OptionGroup::values($name); if (!empty($value)) { while (list($k, $v) = each($value)) { diff --git a/CRM/Case/BAO/Query.php b/CRM/Case/BAO/Query.php index d4e7a8bf09..1ef1714b74 100644 --- a/CRM/Case/BAO/Query.php +++ b/CRM/Case/BAO/Query.php @@ -30,7 +30,7 @@ * @package CRM * @copyright CiviCRM LLC (c) 2004-2016 */ -class CRM_Case_BAO_Query { +class CRM_Case_BAO_Query extends CRM_Core_BAO_Query { /** * Get fields. @@ -716,32 +716,9 @@ case_relation_type.id = case_relationship.relationship_type_id )"; $form->addElement('checkbox', 'case_deleted', ts('Deleted Cases')); } - // add all the custom searchable fields - $extends = array('Case'); - $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $extends); - if ($groupDetails) { - $form->assign('caseGroupTree', $groupDetails); - foreach ($groupDetails as $group) { - foreach ($group['fields'] as $field) { - $fieldId = $field['id']; - $elementName = 'custom_' . $fieldId; - if ($field['data_type'] == 'Date' && $field['is_search_range']) { - CRM_Core_Form_Date::buildDateRange($form, $elementName, 1, '_from', '_to', ts('From:'), FALSE); - } - else { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); - } - } - } - } - $form->setDefaults(array('case_owner' => 1)); - } + self::addCustomFormFields($form, array('Case')); - /** - * @param $row - * @param int $id - */ - public static function searchAction(&$row, $id) { + $form->setDefaults(array('case_owner' => 1)); } /** diff --git a/CRM/Contact/Form/Search/Criteria.php b/CRM/Contact/Form/Search/Criteria.php index 853579ac48..d585366d13 100644 --- a/CRM/Contact/Form/Search/Criteria.php +++ b/CRM/Contact/Form/Search/Criteria.php @@ -371,23 +371,8 @@ class CRM_Contact_Form_Search_Criteria { 'placeholder' => ts('Primary'), )); - // custom data extending addresses - - $extends = array('Address'); - $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $extends); - if ($groupDetails) { - $form->assign('addressGroupTree', $groupDetails); - foreach ($groupDetails as $group) { - foreach ($group['fields'] as $field) { - $elementName = 'custom_' . $field['id']; - if ($field['data_type'] == 'Date' && $field['is_search_range']) { - CRM_Core_Form_Date::buildDateRange($form, $elementName, 1, '_from', '_to', ts('From:'), FALSE); - } - else { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $field['id'], FALSE, TRUE); - } - } - } - } + // custom data extending addresses + CRM_Core_BAO_Query::addCustomFormFields($form, array('Address')); } /** @@ -452,23 +437,7 @@ class CRM_Contact_Form_Search_Criteria { CRM_Core_Form_Date::buildDateRange($form, 'relation_date', 1, '_low', '_high', ts('From:'), FALSE, FALSE); // add all the custom searchable fields - $relationship = array('Relationship'); - $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $relationship); - if ($groupDetails) { - $form->assign('relationshipGroupTree', $groupDetails); - foreach ($groupDetails as $group) { - foreach ($group['fields'] as $field) { - $fieldId = $field['id']; - $elementName = 'custom_' . $fieldId; - if ($field['data_type'] == 'Date' && $field['is_search_range']) { - CRM_Core_Form_Date::buildDateRange($form, $elementName, 1, '_from', '_to', ts('From:'), FALSE); - } - else { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); - } - } - } - } + CRM_Core_BAO_Query::addCustomFormFields($form, array('Relationship')); } /** diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php index cb9a00bbe7..5fd0b09efa 100644 --- a/CRM/Contribute/BAO/ContributionRecur.php +++ b/CRM/Contribute/BAO/ContributionRecur.php @@ -783,23 +783,9 @@ INNER JOIN civicrm_contribution con ON ( con.id = mp.contribution_id ) CRM_Core_Form_Date::buildDateRange($form, 'contribution_recur_cancel_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth'); $form->addElement('text', 'contribution_recur_processor_id', ts('Processor ID'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'processor_id')); $form->addElement('text', 'contribution_recur_trxn_id', ts('Transaction ID'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'trxn_id')); - $contributionRecur = array('ContributionRecur'); - $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $contributionRecur); - if ($groupDetails) { - $form->assign('contributeRecurGroupTree', $groupDetails); - foreach ($groupDetails as $group) { - foreach ($group['fields'] as $field) { - $fieldId = $field['id']; - $elementName = 'custom_' . $fieldId; - if ($field['data_type'] == 'Date' && $field['is_search_range']) { - CRM_Core_Form_Date::buildDateRange($form, $elementName, 1, '_from', '_to', ts('From:'), FALSE); - } - else { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); - } - } - } - } + + CRM_Core_BAO_Query::addCustomFormFields($form, array('ContributionRecur')); + } /** diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php index 7b2779cce8..218e0c34c8 100644 --- a/CRM/Contribute/BAO/Query.php +++ b/CRM/Contribute/BAO/Query.php @@ -30,7 +30,7 @@ * @package CRM * @copyright CiviCRM LLC (c) 2004-2016 */ -class CRM_Contribute_BAO_Query { +class CRM_Contribute_BAO_Query extends CRM_Core_BAO_Query { /** * Static field for all the export/import contribution fields. @@ -1112,24 +1112,7 @@ class CRM_Contribute_BAO_Query { FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -')) ); - // Add all the custom searchable fields - $contribution = array('Contribution'); - $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $contribution); - if ($groupDetails) { - $form->assign('contributeGroupTree', $groupDetails); - foreach ($groupDetails as $group) { - foreach ($group['fields'] as $field) { - $fieldId = $field['id']; - $elementName = 'custom_' . $fieldId; - if ($field['data_type'] == 'Date' && $field['is_search_range']) { - CRM_Core_Form_Date::buildDateRange($form, $elementName, 1, '_from', '_to', ts('From:'), FALSE); - } - else { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); - } - } - } - } + self::addCustomFormFields($form, array('Contribution')); CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'contribution_campaign_id'); @@ -1150,15 +1133,6 @@ class CRM_Contribute_BAO_Query { CRM_Contribute_BAO_ContributionRecur::recurringContribution($form); } - /** - * Function that may not be needed. - * - * @param array $row - * @param int $id - */ - public static function searchAction(&$row, $id) { - } - /** * Get table names. * diff --git a/CRM/Core/BAO/Query.php b/CRM/Core/BAO/Query.php new file mode 100644 index 0000000000..8740f9fc7d --- /dev/null +++ b/CRM/Core/BAO/Query.php @@ -0,0 +1,74 @@ +assign($tplName, $groupDetails); + foreach ($groupDetails as $group) { + foreach ($group['fields'] as $field) { + $fieldId = $field['id']; + $elementName = 'custom_' . $fieldId; + if ($field['data_type'] == 'Date' && $field['is_search_range']) { + CRM_Core_Form_Date::buildDateRange($form, $elementName, 1, '_from', '_to', ts('From:'), FALSE); + } + else { + CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); + } + } + } + } + } + + /** + * Possibly unnecessary function. + * + * @param $row + * @param int $id + */ + public static function searchAction(&$row, $id) {} + + /** + * @param $tables + */ + public static function tableNames(&$tables) {} + +} diff --git a/CRM/Event/BAO/Query.php b/CRM/Event/BAO/Query.php index a0c96f329e..4d3c728b66 100644 --- a/CRM/Event/BAO/Query.php +++ b/CRM/Event/BAO/Query.php @@ -32,7 +32,7 @@ * $Id$ * */ -class CRM_Event_BAO_Query { +class CRM_Event_BAO_Query extends CRM_Core_BAO_Query { /** * Function get the import/export fields for contribution. @@ -512,15 +512,6 @@ class CRM_Event_BAO_Query { return $from; } - /** - * Getter for the qill object. - * - * @return string - */ - public function qill() { - return (isset($this->_qill)) ? $this->_qill : ""; - } - /** * @param $mode * @param bool $includeCustomFields @@ -646,24 +637,8 @@ class CRM_Event_BAO_Query { $form->addRule('participant_fee_amount_low', ts('Please enter a valid money value.'), 'money'); $form->addRule('participant_fee_amount_high', ts('Please enter a valid money value.'), 'money'); - // add all the custom searchable fields - $extends = array('Participant', 'Event'); - $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $extends); - if ($groupDetails) { - $form->assign('participantGroupTree', $groupDetails); - foreach ($groupDetails as $group) { - foreach ($group['fields'] as $field) { - $fieldId = $field['id']; - $elementName = 'custom_' . $fieldId; - if ($field['data_type'] == 'Date' && $field['is_search_range']) { - CRM_Core_Form_Date::buildDateRange($form, $elementName, 1, '_from', '_to', ts('From:'), FALSE); - } - else { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); - } - } - } - } + + self::addCustomFormFields($form, array('Participant', 'Event')); CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'participant_campaign_id'); @@ -671,13 +646,6 @@ class CRM_Event_BAO_Query { $form->setDefaults(array('participant_test' => 0)); } - /** - * @param $row - * @param int $id - */ - public static function searchAction(&$row, $id) { - } - /** * @param $tables */ diff --git a/CRM/Grant/BAO/Query.php b/CRM/Grant/BAO/Query.php index 10222a9339..0463ea9fdb 100644 --- a/CRM/Grant/BAO/Query.php +++ b/CRM/Grant/BAO/Query.php @@ -32,7 +32,7 @@ * $Id$ * */ -class CRM_Grant_BAO_Query { +class CRM_Grant_BAO_Query extends CRM_Core_BAO_Query { /** * @return array */ @@ -267,15 +267,6 @@ class CRM_Grant_BAO_Query { return $from; } - /** - * Getter for the qill object. - * - * @return string - */ - public function qill() { - return (isset($this->_qill)) ? $this->_qill : ""; - } - /** * @param $mode * @param bool $includeCustomFields @@ -354,39 +345,9 @@ class CRM_Grant_BAO_Query { $form->add('text', 'grant_amount_high', ts('Maximum Amount'), array('size' => 8, 'maxlength' => 8)); $form->addRule('grant_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('99.99', ' '))), 'money'); - // add all the custom searchable fields - $grant = array('Grant'); - $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $grant); - if ($groupDetails) { - $form->assign('grantGroupTree', $groupDetails); - foreach ($groupDetails as $group) { - foreach ($group['fields'] as $field) { - $fieldId = $field['id']; - $elementName = 'custom_' . $fieldId; - if ($field['data_type'] == 'Date' && $field['is_search_range']) { - CRM_Core_Form_Date::buildDateRange($form, $elementName, 1, '_from', '_to', ts('From:'), FALSE); - } - else { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); - } - } - } - } + self::addCustomFormFields($form, array('Grant')); $form->assign('validGrant', TRUE); } - /** - * @param $row - * @param int $id - */ - public static function searchAction(&$row, $id) { - } - - /** - * @param $tables - */ - public static function tableNames(&$tables) { - } - } diff --git a/CRM/Member/BAO/Query.php b/CRM/Member/BAO/Query.php index c0f24dd299..97f326651c 100644 --- a/CRM/Member/BAO/Query.php +++ b/CRM/Member/BAO/Query.php @@ -30,7 +30,7 @@ * @package CRM * @copyright CiviCRM LLC (c) 2004-2016 */ -class CRM_Member_BAO_Query { +class CRM_Member_BAO_Query extends CRM_Core_BAO_Query { /** * Get available fields. @@ -505,24 +505,7 @@ class CRM_Member_BAO_Query { $form->addYesNo('member_test', ts('Membership is a Test?'), TRUE); $form->addYesNo('member_is_override', ts('Membership Status Is Overriden?'), TRUE); - // add all the custom searchable fields - $extends = array('Membership'); - $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $extends); - if ($groupDetails) { - $form->assign('membershipGroupTree', $groupDetails); - foreach ($groupDetails as $group) { - foreach ($group['fields'] as $field) { - $fieldId = $field['id']; - $elementName = 'custom_' . $fieldId; - if ($field['data_type'] == 'Date' && $field['is_search_range']) { - CRM_Core_Form_Date::buildDateRange($form, $elementName, 1, '_from', '_to', ts('From:'), FALSE); - } - else { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); - } - } - } - } + self::addCustomFormFields($form, array('Membership')); CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'member_campaign_id'); @@ -530,15 +513,6 @@ class CRM_Member_BAO_Query { $form->setDefaults(array('member_test' => 0)); } - /** - * Possibly un-required function. - * - * @param array $row - * @param int $id - */ - public static function searchAction(&$row, $id) { - } - /** * Add membership table. * diff --git a/CRM/Pledge/BAO/Query.php b/CRM/Pledge/BAO/Query.php index 024a3f01c0..225546c666 100644 --- a/CRM/Pledge/BAO/Query.php +++ b/CRM/Pledge/BAO/Query.php @@ -30,7 +30,7 @@ * @package CRM * @copyright CiviCRM LLC (c) 2004-2016 */ -class CRM_Pledge_BAO_Query { +class CRM_Pledge_BAO_Query extends CRM_Core_BAO_Query { /** * Get pledge fields. * @@ -430,15 +430,6 @@ class CRM_Pledge_BAO_Query { return $from; } - /** - * Getter for the qill object. - * - * @return string - */ - public function qill() { - return (isset($this->_qill)) ? $this->_qill : ""; - } - /** * Ideally this function should include fields that are displayed in the selector. * @@ -577,24 +568,7 @@ class CRM_Pledge_BAO_Query { array('' => ts('- any -')) + $freqUnitsDisplay ); - // add all the custom searchable fields - $pledge = array('Pledge'); - $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $pledge); - if ($groupDetails) { - $form->assign('pledgeGroupTree', $groupDetails); - foreach ($groupDetails as $group) { - foreach ($group['fields'] as $field) { - $fieldId = $field['id']; - $elementName = 'custom_' . $fieldId; - if ($field['data_type'] == 'Date' && $field['is_search_range']) { - CRM_Core_Form_Date::buildDateRange($form, $elementName, 1, '_from', '_to', ts('From:'), FALSE); - } - else { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); - } - } - } - } + self::addCustomFormFields($form, array('Pledge')); CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'pledge_campaign_id'); @@ -602,13 +576,6 @@ class CRM_Pledge_BAO_Query { $form->setDefaults(array('pledge_test' => 0)); } - /** - * @param $row - * @param int $id - */ - public static function searchAction(&$row, $id) { - } - /** * @param $tables */ diff --git a/templates/CRM/Contribute/Form/Search/Common.tpl b/templates/CRM/Contribute/Form/Search/Common.tpl index d4ad3b71e5..301a4b6fb9 100644 --- a/templates/CRM/Contribute/Form/Search/Common.tpl +++ b/templates/CRM/Contribute/Form/Search/Common.tpl @@ -167,10 +167,10 @@ campaignTrClass='' campaignTdClass=''} -{if $contributeGroupTree} +{if $contributionGroupTree} - {include file="CRM/Custom/Form/Search.tpl" groupTree=$contributeGroupTree showHideLinks=false} + {include file="CRM/Custom/Form/Search.tpl" groupTree=$contributionGroupTree showHideLinks=false} {/if} diff --git a/templates/CRM/Contribute/Form/Search/ContributionRecur.tpl b/templates/CRM/Contribute/Form/Search/ContributionRecur.tpl index f068d30809..31e0f9bfc8 100644 --- a/templates/CRM/Contribute/Form/Search/ContributionRecur.tpl +++ b/templates/CRM/Contribute/Form/Search/ContributionRecur.tpl @@ -70,10 +70,10 @@ {include file="CRM/Core/DateRange.tpl" fieldName="contribution_recur_cancel_date" from='_low' to='_high'} - {if $contributeRecurGroupTree} + {if $contributionRecurGroupTree} - {include file="CRM/Custom/Form/Search.tpl" groupTree=$contributeRecurGroupTree showHideLinks=false} + {include file="CRM/Custom/Form/Search.tpl" groupTree=$contributionRecurGroupTree showHideLinks=false} {/if} -- 2.25.1