From 7a139dddc05d8e9c48db48532c3351f6c87a53a1 Mon Sep 17 00:00:00 2001 From: Romain Quetiez Date: Thu, 9 Jul 2015 07:36:39 +0000 Subject: [PATCH] Code cleanup: deprecated the unused (and empty) class CMDBSearchFilter, replaced by DBSearch or DBObjectSearch depending on the usage. SVN:trunk[3632] --- application/displayblock.class.inc.php | 4 ++-- core/attributedef.class.inc.php | 4 ++-- core/bulkchange.class.inc.php | 10 +++++----- core/cmdbobject.class.inc.php | 17 ++--------------- core/data.generator.class.inc.php | 10 +++++----- core/dbobjectset.class.php | 2 +- pages/UI.php | 6 +++--- pages/UniversalSearch.php | 10 +++++----- pages/ajax.render.php | 20 ++++++++++---------- pages/audit.php | 4 ++-- webservices/webservices.class.inc.php | 8 ++++---- 11 files changed, 41 insertions(+), 54 deletions(-) diff --git a/application/displayblock.class.inc.php b/application/displayblock.class.inc.php index 8161d3ff0..b49bf986c 100644 --- a/application/displayblock.class.inc.php +++ b/application/displayblock.class.inc.php @@ -180,11 +180,11 @@ class DisplayBlock switch($sEncoding) { case 'text/serialize': - $oFilter = CMDBSearchFilter::unserialize($sITopData); + $oFilter = DBSearch::unserialize($sITopData); break; case 'text/oql': - $oFilter = CMDBSearchFilter::FromOQL($sITopData); + $oFilter = DBSearch::FromOQL($sITopData); break; } return new $sBlockClass($oFilter, $sBlockType, $bAsynchronous, $aParams); diff --git a/core/attributedef.class.inc.php b/core/attributedef.class.inc.php index 7ac55c71a..16f8ace95 100644 --- a/core/attributedef.class.inc.php +++ b/core/attributedef.class.inc.php @@ -20,7 +20,7 @@ /** * Typology for the attributes * - * @copyright Copyright (C) 2010-2012 Combodo SARL + * @copyright Copyright (C) 2010-2015 Combodo SARL * @license http://opensource.org/licenses/AGPL-3.0 */ @@ -930,7 +930,7 @@ class AttributeLinkedSet extends AttributeDefinition { $oKeyAttDef = MetaModel::GetAttributeDef($sTargetClass, $sKeyAttCode); $sKeyClass = $oKeyAttDef->GetTargetClass(); - $oExtKeyFilter = new CMDBSearchFilter($sKeyClass); + $oExtKeyFilter = new DBObjectSearch($sKeyClass); $aReconciliationDesc = array(); foreach($aReconciliation as $sRemoteAttCode => $sValue) { diff --git a/core/bulkchange.class.inc.php b/core/bulkchange.class.inc.php index a9c25368c..13c095f3b 100644 --- a/core/bulkchange.class.inc.php +++ b/core/bulkchange.class.inc.php @@ -1,5 +1,5 @@ m_sClass, $sAttCode); - $oReconFilter = new CMDBSearchFilter($oExtKey->GetTargetClass()); + $oReconFilter = new DBObjectSearch($oExtKey->GetTargetClass()); foreach ($this->m_aExtKeys[$sAttCode] as $sForeignAttCode => $iCol) { if ($sForeignAttCode == 'id') @@ -366,7 +366,7 @@ class BulkChange } else { - $oReconFilter = new CMDBSearchFilter($oExtKey->GetTargetClass()); + $oReconFilter = new DBObjectSearch($oExtKey->GetTargetClass()); $aCacheKeys = array(); foreach ($aKeyConfig as $sForeignAttCode => $iCol) { @@ -839,7 +839,7 @@ class BulkChange } try { - $oReconciliationFilter = new CMDBSearchFilter($this->m_sClass); + $oReconciliationFilter = new DBObjectSearch($this->m_sClass); $bSkipQuery = false; foreach($this->m_aReconcilKeys as $sAttCode) { diff --git a/core/cmdbobject.class.inc.php b/core/cmdbobject.class.inc.php index 397ffe055..d80b9aac3 100644 --- a/core/cmdbobject.class.inc.php +++ b/core/cmdbobject.class.inc.php @@ -582,7 +582,7 @@ class CMDBObjectSet extends DBObjectSet static public function FromScratch($sClass) { - $oFilter = new CMDBSearchFilter($sClass); + $oFilter = new DBObjectSearch($sClass); $oFilter->AddConditionExpression(new FalseExpression()); $oRetSet = new self($oFilter); // NOTE: THIS DOES NOT WORK IF m_bLoaded is private in the base class (and you will not get any error message) @@ -606,7 +606,7 @@ class CMDBObjectSet extends DBObjectSet // let's create one search definition $sClass = reset($aClasses); $sAlias = key($aClasses); - $oFilter = new CMDBSearchFilter($sClass, $sAlias); + $oFilter = new DBObjectSearch($sClass, $sAlias); $oRetSet = new CMDBObjectSet($oFilter); $oRetSet->m_bLoaded = true; // no DB load @@ -618,16 +618,3 @@ class CMDBObjectSet extends DBObjectSet return $oRetSet; } } - -/** - * TODO: investigate how to get rid of this class that was made to workaround some language limitation... or a poor design! - * - * @package iTopORM - */ -class CMDBSearchFilter extends DBObjectSearch -{ - // this is the public interface (?) -} - - -?> diff --git a/core/data.generator.class.inc.php b/core/data.generator.class.inc.php index 08afde4fc..ca5260363 100644 --- a/core/data.generator.class.inc.php +++ b/core/data.generator.class.inc.php @@ -1,5 +1,5 @@ $filterValue) { $oFilter->AddCondition($sFilterCode, $filterValue, '='); @@ -346,7 +346,7 @@ class cmdbDataGenerator */ protected function OrganizationExists($sCode) { - $oFilter = new CMDBSearchFilter('bizOrganization'); + $oFilter = new DBObjectSearch('Organization'); $oFilter->AddCondition('code', $sCode, '='); $oSet = new CMDBObjectSet($oFilter); return ($oSet->Count() > 0); @@ -361,7 +361,7 @@ class cmdbDataGenerator protected function GetOrganization($sId) { $oOrg = null; - $oFilter = new CMDBSearchFilter('bizOrganization'); + $oFilter = new DBObjectSearch('Organization'); $oFilter->AddCondition('id', $sId, '='); $oSet = new CMDBObjectSet($oFilter); if ($oSet->Count() > 0) diff --git a/core/dbobjectset.class.php b/core/dbobjectset.class.php index 25bce6fad..90b5f445c 100644 --- a/core/dbobjectset.class.php +++ b/core/dbobjectset.class.php @@ -237,7 +237,7 @@ class DBObjectSet // let's create one search definition corresponding only to the first column $sClass = reset($aClasses); $sAlias = key($aClasses); - $oFilter = new CMDBSearchFilter($sClass, $sAlias); + $oFilter = new DBObjectSearch($sClass, $sAlias); $oRetSet = new self($oFilter); $oRetSet->m_bLoaded = true; // no DB load diff --git a/pages/UI.php b/pages/UI.php index 4983a5110..c72d7694e 100644 --- a/pages/UI.php +++ b/pages/UI.php @@ -421,7 +421,7 @@ try /////////////////////////////////////////////////////////////////////////////////////////// - case 'search': // Serialized CMDBSearchFilter + case 'search': // Serialized DBSearch $sFilter = utils::ReadParam('filter', '', false, 'raw_data'); $sFormat = utils::ReadParam('format', ''); $bSearchForm = utils::ReadParam('search_form', true); @@ -431,7 +431,7 @@ try } $oP->set_title(Dict::S('UI:SearchResultsPageTitle')); // TO DO: limit the search filter by the user context - $oFilter = CMDBSearchFilter::unserialize($sFilter); // TO DO : check that the filter is valid + $oFilter = DBSearch::unserialize($sFilter); // TO DO : check that the filter is valid DisplaySearchSet($oP, $oFilter, $bSearchForm, '' /* sBaseClass */, $sFormat); break; @@ -836,7 +836,7 @@ EOF $oP->set_title(Dict::S('UI:BulkDeletePageTitle')); $oP->add("

".Dict::S('UI:BulkDeleteTitle')."

\n"); // TO DO: limit the search filter by the user context - $oFilter = CMDBSearchFilter::unserialize($sFilter); // TO DO : check that the filter is valid + $oFilter = DBSearch::unserialize($sFilter); // TO DO : check that the filter is valid $oChecker = new ActionChecker($oFilter, UR_ACTION_BULK_DELETE); DisplayMultipleSelectionForm($oP, $oFilter, 'bulk_delete', $oChecker); break; diff --git a/pages/UniversalSearch.php b/pages/UniversalSearch.php index 39c8ecec5..1ccb7d062 100644 --- a/pages/UniversalSearch.php +++ b/pages/UniversalSearch.php @@ -1,5 +1,5 @@ P("".Dict::Format('UI:UniversalSearch:Error', $e->getHtmlDesc()).""); } diff --git a/pages/ajax.render.php b/pages/ajax.render.php index e9398eadd..68b678d47 100644 --- a/pages/ajax.render.php +++ b/pages/ajax.render.php @@ -20,7 +20,7 @@ /** * Handles various ajax requests * - * @copyright Copyright (C) 2010-2012 Combodo SARL + * @copyright Copyright (C) 2010-2015 Combodo SARL * @license http://opensource.org/licenses/AGPL-3.0 */ @@ -78,11 +78,11 @@ try } if ($sEncoding == 'oql') { - $oFilter = CMDBSearchFilter::FromOQL($sFilter); + $oFilter = DBSearch::FromOQL($sFilter); } else { - $oFilter = CMDBSearchFilter::unserialize($sFilter); + $oFilter = DBSearch::unserialize($sFilter); } $iStart = utils::ReadParam('start',0); $iEnd = utils::ReadParam('end',1); @@ -651,11 +651,11 @@ try $_REQUEST['c'] = $aContext; if ($sEncoding == 'oql') { - $oFilter = CMDBSearchFilter::FromOQL($sFilter); + $oFilter = DBSearch::FromOQL($sFilter); } else { - $oFilter = CMDBSearchFilter::unserialize($sFilter); + $oFilter = DBSearch::unserialize($sFilter); } $oDisplayBlock = new DisplayBlock($oFilter, $sStyle, false); $aExtraParams['display_limit'] = true; @@ -690,11 +690,11 @@ try { if ($sEncoding == 'oql') { - $oFilter = CMDBSearchFilter::FromOQL($sFilter); + $oFilter = DBSearch::FromOQL($sFilter); } else { - $oFilter = CMDBSearchFilter::unserialize($sFilter); + $oFilter = DBSearch::unserialize($sFilter); } $oDisplayBlock = new DisplayBlock($oFilter, 'pie_chart_ajax', false); $oDisplayBlock->RenderContent($oPage, array('group_by' => $sGroupBy)); @@ -717,7 +717,7 @@ try $aParams = utils::ReadParam('params', array(), false, 'raw_data'); if ($sFilter != '') { - $oFilter = CMDBSearchFilter::unserialize($sFilter); + $oFilter = DBSearch::unserialize($sFilter); $oDisplayBlock = new DisplayBlock($oFilter, 'open_flash_chart_ajax', false); $oDisplayBlock->RenderContent($oPage, $aParams); } @@ -760,7 +760,7 @@ try case 'combo_options': $oPage->SetContentType('text/html'); - $oFilter = CMDBSearchFilter::FromOQL($sFilter); + $oFilter = DBSearch::FromOQL($sFilter); $oSet = new CMDBObjectSet($oFilter); while( $oObj = $oSet->fetch()) { @@ -1310,7 +1310,7 @@ EOF case 'history_from_filter': $oPage->SetContentType('text/html'); - $oHistoryFilter = CMDBSearchFilter::unserialize($sFilter); + $oHistoryFilter = DBSearch::unserialize($sFilter); $iStart = (int)utils::ReadParam('start', 0); $iCount = (int)utils::ReadParam('count', MetaModel::GetConfig()->Get('max_history_length', '50')); $oBlock = new HistoryBlock($oHistoryFilter, 'table', false); diff --git a/pages/audit.php b/pages/audit.php index c9d0cbd13..e056788bf 100644 --- a/pages/audit.php +++ b/pages/audit.php @@ -245,7 +245,7 @@ try case 'audit': default: $oP->add(''); - $oAuditFilter = new CMDBSearchFilter('AuditCategory'); + $oAuditFilter = new DBObjectSearch('AuditCategory'); $oCategoriesSet = new DBObjectSet($oAuditFilter); $oP->add("\n"); $oP->add("
\n"); @@ -271,7 +271,7 @@ try $aResults = array(); $oDefinitionSet = new CMDBObjectSet($oDefinitionFilter); $iCount = $oDefinitionSet->Count(); - $oRulesFilter = new CMDBSearchFilter('AuditRule'); + $oRulesFilter = new DBObjectSearch('AuditRule'); $oRulesFilter->AddCondition('category_id', $oAuditCategory->GetKey(), '='); $oRulesSet = new DBObjectSet($oRulesFilter); while($oAuditRule = $oRulesSet->fetch() ) diff --git a/webservices/webservices.class.inc.php b/webservices/webservices.class.inc.php index a72b792da..ef7f9611f 100644 --- a/webservices/webservices.class.inc.php +++ b/webservices/webservices.class.inc.php @@ -1,5 +1,5 @@ GetTargetClass(); - $oReconFilter = new CMDBSearchFilter($sKeyClass); + $oReconFilter = new DBObjectSearch($sKeyClass); foreach ($aExtKeyDesc as $sForeignAttCode => $value) { if (!MetaModel::IsValidFilterCode($sKeyClass, $sForeignAttCode)) @@ -443,7 +443,7 @@ abstract class WebServicesBase $oRes->LogError("Parameter $sParamName: '$sTargetClass' is not a child class of '$sLinkedClass'"); continue; // skip } - $oReconFilter = new CMDBSearchFilter($sTargetClass); + $oReconFilter = new DBObjectSearch($sTargetClass); $aCIStringDesc = array(); foreach ($aItemData['search'] as $sAttCode => $value) {