#1240 Coding style fixes (merge 'master')

OPUS4 · Oct 14, 2024 · 1a7cc9c · 1a7cc9c
2 parents 3bb1c7c + 9a5fccb
commit 1a7cc9c
Show file tree

Hide file tree

Showing 17 changed files with 81 additions and 58 deletions.
diff --git a/library/Application/Form/Element/SearchFieldModifier.php b/library/Application/Form/Element/SearchFieldModifier.php
@@ -29,16 +29,18 @@
  * @license     http://www.gnu.org/licenses/gpl.html General Public License
  */
 
+use Opus\Search\Util\Query;
+
 class Application_Form_Element_SearchFieldModifier extends Application_Form_Element_Select
 {
     public function init()
     {
         parent::init();
 
         $options = [
-            Opus\Search\Util\Query::SEARCH_MODIFIER_CONTAINS_ALL  => 'advanced_search_form_modifier_all',
-            Opus\Search\Util\Query::SEARCH_MODIFIER_CONTAINS_ANY  => 'advanced_search_form_modifier_one',
-            Opus\Search\Util\Query::SEARCH_MODIFIER_CONTAINS_NONE => 'advanced_search_form_modifier_none',
+            Query::SEARCH_MODIFIER_CONTAINS_ALL  => 'advanced_search_form_modifier_all',
+            Query::SEARCH_MODIFIER_CONTAINS_ANY  => 'advanced_search_form_modifier_one',
+            Query::SEARCH_MODIFIER_CONTAINS_NONE => 'advanced_search_form_modifier_none',
         ];
 
         $this->addMultiOptions($options);

diff --git a/modules/export/models/XmlExport.php b/modules/export/models/XmlExport.php
@@ -32,6 +32,7 @@
 use Opus\Common\Document;
 use Opus\Common\Repository;
 use Opus\Common\Security\Realm;
+use Opus\Search\Util\Query;
 
 /**
  * Export plugin for exporting documents as XML.
@@ -319,7 +320,7 @@ public function prepareXml()
      */
     public function getMaxRows()
     {
-        $maxRows = Opus\Search\Util\Query::MAX_ROWS;
+        $maxRows = Query::MAX_ROWS;
 
         $config = $this->getConfig();
 
@@ -338,8 +339,8 @@ public function getMaxRows()
         }
 
         // Do not allows configured values to exceed java.lang.Integer.MAX_VALUE (Solr)
-        if ($maxRows > Opus\Search\Util\Query::MAX_ROWS) {
-            $maxRows = Opus\Search\Util\Query::MAX_ROWS;
+        if ($maxRows > Query::MAX_ROWS) {
+            $maxRows = Query::MAX_ROWS;
         }
 
         return $maxRows;

diff --git a/modules/solrsearch/controllers/BrowseController.php b/modules/solrsearch/controllers/BrowseController.php
@@ -30,6 +30,7 @@
  */
 
 use Opus\Search\SearchException;
+use Opus\Search\Util\Query;
 
 /**
  * TODO move list handling into model
@@ -83,7 +84,7 @@ public function doctypesAction()
         }
 
         $facetname = 'doctype';
-        $query     = new Opus\Search\Util\Query(Opus\Search\Util\Query::FACET_ONLY);
+        $query     = new Query(Query::FACET_ONLY);
         $query->setFacetField($facetname);
 
         try {
@@ -119,7 +120,7 @@ public function yearsAction()
 
         $facetname = 'year';
 
-        $query = new Opus\Search\Util\Query(Opus\Search\Util\Query::FACET_ONLY);
+        $query = new Query(Query::FACET_ONLY);
 
         $facetManager = new Application_Search_FacetManager();
         $facet        = $facetManager->getFacet($facetname);

diff --git a/modules/solrsearch/forms/AdvancedSearch.php b/modules/solrsearch/forms/AdvancedSearch.php
@@ -29,6 +29,8 @@
  * @license     http://www.gnu.org/licenses/gpl.html General Public License
  */
 
+use Opus\Search\Util\Query;
+
 /**
  * Advanced search form.
  *
@@ -203,7 +205,7 @@ public function addSearchField($name)
         ]);
 
         if ($name === 'fulltext') {
-            $modifier->removeMultiOption(Opus\Search\Util\Query::SEARCH_MODIFIER_CONTAINS_ANY);
+            $modifier->removeMultiOption(Query::SEARCH_MODIFIER_CONTAINS_ANY);
         }
         $this->addElement($modifier);
 

diff --git a/modules/solrsearch/models/FacetMenu.php b/modules/solrsearch/models/FacetMenu.php
@@ -30,6 +30,7 @@
  */
 
 use Opus\Common\CollectionRole;
+use Opus\Search\Facet\Set;
 
 /**
  * TODO refactor as view helper or something better
@@ -45,7 +46,7 @@ class Solrsearch_Model_FacetMenu extends Application_Model_Abstract
     public function buildFacetArray($paramSet)
     {
         // TODO not sure I like processing request parameters in *opus4-search* class (backend code)
-        return Opus\Search\Facet\Set::getFacetLimitsFromInput($paramSet);
+        return Set::getFacetLimitsFromInput($paramSet);
     }
 
     /**

diff --git a/modules/solrsearch/models/Search.php b/modules/solrsearch/models/Search.php
@@ -29,6 +29,8 @@
  * @license     http://www.gnu.org/licenses/gpl.html General Public License
  */
 
+use Opus\Search\Util\Query;
+
 /**
  * Modelklasse fuer Suchfunktionalität, die von den Controllern verwendet wird.
  */
@@ -89,7 +91,7 @@ public function createAdvancedSearchUrlParams($request)
                 $params[$fieldname]              = $fieldvalue;
                 $params[$fieldname . 'modifier'] = $request->getParam(
                     $fieldname . 'modifier',
-                    Opus\Search\Util\Query::SEARCH_MODIFIER_CONTAINS_ALL
+                    Query::SEARCH_MODIFIER_CONTAINS_ALL
                 );
             }
         }
@@ -104,7 +106,7 @@ public function createBasicSearchParams($request)
     {
         return [
             'start'     => $request->getParam('start', '0'),
-            'rows'      => $request->getParam('rows', Opus\Search\Util\Query::getDefaultRows()),
+            'rows'      => $request->getParam('rows', Query::getDefaultRows()),
             'sortfield' => $request->getParam('sortfield', 'score'),
             'sortorder' => $request->getParam('sortorder', 'desc'),
         ];

diff --git a/modules/solrsearch/models/Search/Abstract.php b/modules/solrsearch/models/Search/Abstract.php
@@ -29,6 +29,7 @@
  * @license     http://www.gnu.org/licenses/gpl.html General Public License
  */
 
+use Opus\Search\Config;
 use Opus\Search\Result\Base;
 use Opus\Search\SearchException;
 use Opus\Search\Util\Query;
@@ -67,7 +68,7 @@ public function __construct()
 
         $this->filterFields = [];
 
-        $filters = Opus\Search\Config::getFacetNames();
+        $filters = Config::getFacetNames();
         if (! count($filters)) {
             $logger->debug('key searchengine.solr.facets is not present in config. skipping filter queries');
         } else {

diff --git a/scripts/snippets/find_modified_docs_in_searchindex.php b/scripts/snippets/find_modified_docs_in_searchindex.php
@@ -31,6 +31,8 @@
 
 use Opus\Common\Document;
 use Opus\Common\Repository;
+use Opus\Search\QueryFactory;
+use Opus\Search\Service;
 
 /**
  * Dieses Skript findet alle Dokumente mit ServerState=published, deren ServerDateModified im Solr-Index kleiner ist
@@ -49,8 +51,8 @@
 
 foreach ($finder->getIds() as $docId) {
     // check if document with id $docId is already persisted in search index
-    $search = Opus\Search\Service::selectSearchingService();
-    $query  = Opus\Search\QueryFactory::selectDocumentById($search, $docId);
+    $search = Service::selectSearchingService();
+    $query  = QueryFactory::selectDocumentById($search, $docId);
 
     if ($search->customSearch($query)->getAllMatchesCount() !== 1) {
         echo "ERROR: document # $docId is not stored in search index\n";

diff --git a/tests/library/Application/Form/Element/SearchFieldModifierTest.php b/tests/library/Application/Form/Element/SearchFieldModifierTest.php
@@ -29,6 +29,8 @@
  * @license     http://www.gnu.org/licenses/gpl.html General Public License
  */
 
+use Opus\Search\Util\Query;
+
 class Application_Form_Element_SearchFieldModifierTest extends ControllerTestCase
 {
     public function testOptions()
@@ -39,18 +41,18 @@ public function testOptions()
 
         $this->assertCount(3, $options);
 
-        $this->assertNotNull($element->getMultiOption(Opus\Search\Util\Query::SEARCH_MODIFIER_CONTAINS_ALL));
-        $this->assertNotNull($element->getMultiOption(Opus\Search\Util\Query::SEARCH_MODIFIER_CONTAINS_ANY));
-        $this->assertNotNull($element->getMultiOption(Opus\Search\Util\Query::SEARCH_MODIFIER_CONTAINS_NONE));
+        $this->assertNotNull($element->getMultiOption(Query::SEARCH_MODIFIER_CONTAINS_ALL));
+        $this->assertNotNull($element->getMultiOption(Query::SEARCH_MODIFIER_CONTAINS_ANY));
+        $this->assertNotNull($element->getMultiOption(Query::SEARCH_MODIFIER_CONTAINS_NONE));
     }
 
     public function testValidationTrue()
     {
         $element = new Application_Form_Element_SearchFieldModifier('modifier');
 
-        $this->assertTrue($element->isValid(Opus\Search\Util\Query::SEARCH_MODIFIER_CONTAINS_ALL));
-        $this->assertTrue($element->isValid(Opus\Search\Util\Query::SEARCH_MODIFIER_CONTAINS_ANY));
-        $this->assertTrue($element->isValid(Opus\Search\Util\Query::SEARCH_MODIFIER_CONTAINS_NONE));
+        $this->assertTrue($element->isValid(Query::SEARCH_MODIFIER_CONTAINS_ALL));
+        $this->assertTrue($element->isValid(Query::SEARCH_MODIFIER_CONTAINS_ANY));
+        $this->assertTrue($element->isValid(Query::SEARCH_MODIFIER_CONTAINS_NONE));
     }
 
     public function testValidationFalse()

diff --git a/tests/modules/admin/controllers/IndexmaintenanceControllerTest.php b/tests/modules/admin/controllers/IndexmaintenanceControllerTest.php
@@ -32,6 +32,7 @@
 use Opus\Common\Job;
 use Opus\Common\Log;
 use Opus\Job\Runner;
+use Opus\Search\Task\ConsistencyCheck;
 
 /**
  * @covers Admin_IndexmaintenanceController
@@ -59,7 +60,7 @@ public function tearDown(): void
         }
 
         // Cleanup of Jobs Table
-        $jobs = Job::getByLabels([Opus\Search\Task\ConsistencyCheck::LABEL]);
+        $jobs = Job::getByLabels([ConsistencyCheck::LABEL]);
         foreach ($jobs as $job) {
             try {
                 $job->delete();
@@ -248,7 +249,7 @@ public function testCheckconsistencyActionWithEnabledFeature()
     {
         $this->enableAsyncIndexmaintenanceMode();
 
-        $numOfJobs = Job::getCountForLabel(Opus\Search\Task\ConsistencyCheck::LABEL);
+        $numOfJobs = Job::getCountForLabel(ConsistencyCheck::LABEL);
         $this->assertEquals(0, $numOfJobs);
 
         $this->getRequest()->setMethod('POST');
@@ -257,27 +258,27 @@ public function testCheckconsistencyActionWithEnabledFeature()
         $this->assertResponseCode(302);
         $this->assertResponseLocationHeader($this->getResponse(), '/admin/indexmaintenance');
 
-        $this->assertEquals(1, Job::getCountForLabel(Opus\Search\Task\ConsistencyCheck::LABEL));
+        $this->assertEquals(1, Job::getCountForLabel(ConsistencyCheck::LABEL));
 
-        $jobs = Job::getByLabels([Opus\Search\Task\ConsistencyCheck::LABEL]);
+        $jobs = Job::getByLabels([ConsistencyCheck::LABEL]);
         $jobs[0]->delete();
 
-        $this->assertEquals(0, Job::getCountForLabel(Opus\Search\Task\ConsistencyCheck::LABEL));
+        $this->assertEquals(0, Job::getCountForLabel(ConsistencyCheck::LABEL));
     }
 
     public function testCheckconsistencyActionResult()
     {
         $this->enableAsyncIndexmaintenanceMode();
 
-        $this->assertEquals(0, Job::getCountForLabel(Opus\Search\Task\ConsistencyCheck::LABEL), 'missing cleanup of jobs table');
+        $this->assertEquals(0, Job::getCountForLabel(ConsistencyCheck::LABEL), 'missing cleanup of jobs table');
 
         $this->getRequest()->setMethod('POST');
         $this->dispatch('/admin/indexmaintenance/checkconsistency');
 
         $this->assertResponseCode(302);
         $this->assertResponseLocationHeader($this->getResponse(), '/admin/indexmaintenance');
 
-        $this->assertEquals(1, Job::getCountForLabel(Opus\Search\Task\ConsistencyCheck::LABEL), 'consistency check job was not stored in database');
+        $this->assertEquals(1, Job::getCountForLabel(ConsistencyCheck::LABEL), 'consistency check job was not stored in database');
 
         /*
          * check if job was scheduled for execution
@@ -300,11 +301,11 @@ public function testCheckconsistencyActionResult()
          */
         $jobrunner = new Runner();
         $jobrunner->setLogger(Log::get());
-        $worker = new Opus\Search\Task\ConsistencyCheck();
+        $worker = new ConsistencyCheck();
         $jobrunner->registerWorker($worker);
         $jobrunner->run();
 
-        $jobs = Job::getByLabels([Opus\Search\Task\ConsistencyCheck::LABEL]);
+        $jobs = Job::getByLabels([ConsistencyCheck::LABEL]);
         if (count($jobs) > 0) {
             $job     = $jobs[0];
             $message = 'at least one unexpected job found (Label: \'%s\', State: \'%s\', Data: \'%s\', Errors: \'%s\, SHA1 Hash: \'%s\')';
@@ -316,7 +317,7 @@ public function testCheckconsistencyActionResult()
             $this->fail(sprintf($message, $label, $state, $data, $errors, $hash));
         }
 
-        $this->assertEquals(0, Job::getCountForLabel(Opus\Search\Task\ConsistencyCheck::LABEL), 'consistency check job was not removed from database after execution');
+        $this->assertEquals(0, Job::getCountForLabel(ConsistencyCheck::LABEL), 'consistency check job was not removed from database after execution');
 
         $this->resetResponse();
         $this->resetRequest();

diff --git a/tests/modules/admin/models/IndexMaintenanceTest.php b/tests/modules/admin/models/IndexMaintenanceTest.php
@@ -33,6 +33,7 @@
 use Opus\Common\Job;
 use Opus\Common\Log;
 use Opus\Job\Runner;
+use Opus\Search\Task\ConsistencyCheck;
 
 class Admin_Model_IndexMaintenanceTest extends ControllerTestCase
 {
@@ -61,7 +62,7 @@ public function tearDown(): void
         }
 
         // Cleanup of Jobs Table
-        $jobs = Job::getByLabels([Opus\Search\Task\ConsistencyCheck::LABEL]);
+        $jobs = Job::getByLabels([ConsistencyCheck::LABEL]);
         foreach ($jobs as $job) {
             try {
                 $job->delete();
@@ -147,7 +148,7 @@ public function testNotAllowConsistencyCheck()
         $model->createJob();
         $this->assertFalse($model->allowConsistencyCheck());
 
-        $this->assertEquals(1, Job::getCountForLabel(Opus\Search\Task\ConsistencyCheck::LABEL));
+        $this->assertEquals(1, Job::getCountForLabel(ConsistencyCheck::LABEL));
     }
 
     public function testNotAllowConsistencyCheckAlt()
@@ -158,7 +159,7 @@ public function testNotAllowConsistencyCheckAlt()
         $model->createJob();
         $this->assertFalse($model->allowConsistencyCheck());
 
-        $this->assertEquals(1, Job::getCountForLabel(Opus\Search\Task\ConsistencyCheck::LABEL));
+        $this->assertEquals(1, Job::getCountForLabel(ConsistencyCheck::LABEL));
     }
 
     public function testProcessingStateInvalidContext()
@@ -170,15 +171,15 @@ public function testProcessingStateInvalidContext()
 
     private function runJobImmediately()
     {
-        $this->assertEquals(1, Job::getCountForLabel(Opus\Search\Task\ConsistencyCheck::LABEL));
+        $this->assertEquals(1, Job::getCountForLabel(ConsistencyCheck::LABEL));
 
         $jobrunner = new Runner();
         $jobrunner->setLogger(Log::get());
-        $worker = new Opus\Search\Task\ConsistencyCheck();
+        $worker = new ConsistencyCheck();
         $jobrunner->registerWorker($worker);
         $jobrunner->run();
 
-        $this->assertEquals(0, Job::getCountForLabel(Opus\Search\Task\ConsistencyCheck::LABEL));
+        $this->assertEquals(0, Job::getCountForLabel(ConsistencyCheck::LABEL));
     }
 
     public function testProcessingStateInitial()

diff --git a/tests/modules/export/models/XmlExportTest.php b/tests/modules/export/models/XmlExportTest.php
@@ -31,6 +31,7 @@
 
 use Opus\Common\Repository;
 use Opus\Common\Title;
+use Opus\Search\Util\Query;
 
 /**
  * @covers \Export_Model_XmlExport
@@ -237,7 +238,7 @@ public function testXmlExportForSearchtypeIdWithUnpublishedDocument()
 
     public function testGetMaxRows()
     {
-        $this->assertEquals(Opus\Search\Util\Query::MAX_ROWS, $this->plugin->getMaxRows());
+        $this->assertEquals(Query::MAX_ROWS, $this->plugin->getMaxRows());
 
         $this->enableSecurity();
 
@@ -249,7 +250,7 @@ public function testGetMaxRows()
 
         $this->loginUser('admin', 'adminadmin');
 
-        $this->assertEquals(Opus\Search\Util\Query::MAX_ROWS, $this->plugin->getMaxRows());
+        $this->assertEquals(Query::MAX_ROWS, $this->plugin->getMaxRows());
     }
 
     public function testGetValueIfValid()

diff --git a/tests/modules/home/controllers/IndexControllerTest.php b/tests/modules/home/controllers/IndexControllerTest.php
@@ -31,6 +31,7 @@
 
 use Opus\Search\Result\Base;
 use Opus\Search\SearchException;
+use Opus\Search\Util\Query;
 
 /**
  * Basic unit test for inded controller of home module.
@@ -144,9 +145,9 @@ public function testNoticeAction()
     private function getDocsInSearchIndex($checkConsistency = true)
     {
         $searcher = Application_Search_SearcherFactory::getSearcher();
-        $query    = new Opus\Search\Util\Query();
+        $query    = new Query();
         $query->setCatchAll("*:*");
-        $query->setRows(Opus\Search\Util\Query::MAX_ROWS);
+        $query->setRows(Query::MAX_ROWS);
         return $searcher->search($query, $checkConsistency);
     }