Refactor SearchParams and SearchTabs view helpers to use autowiring (#5085)

Author: sambhavp96

module/VuFind/src/VuFind/View/Helper/Root/SearchParams.php

@@ -30,6 +30,7 @@
 namespace VuFind\View\Helper\Root;
 
 use VuFind\Search\Params\PluginManager;
+use VuFind\ServiceManager\Factory\Autowire;
 
 /**
  * "Retrieve search params" view helper
@@ -40,23 +41,17 @@
  * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
  * @link     https://vufind.org/wiki/development Wiki
  */
-class SearchParams extends \Laminas\View\Helper\AbstractHelper
+class SearchParams
 {
-    /**
-     * Search manager
-     *
-     * @var PluginManager
-     */
-    protected $manager;
-
     /**
      * Constructor
      *
      * @param PluginManager $manager Search manager
      */
-    public function __construct(PluginManager $manager)
-    {
-        $this->manager = $manager;
+    public function __construct(
+        #[Autowire]
+        protected PluginManager $manager
+    ) {
     }
 
     /**

module/VuFind/src/VuFind/View/Helper/Root/SearchParamsFactory.php

@@ -31,12 +31,13 @@
 
 namespace VuFind\View\Helper\Root;
 
-use Laminas\Http\Request;
-use Laminas\View\Helper\Url;
+use Psr\Log\LoggerAwareInterface;
+use VuFind\Log\LoggerAwareTrait;
 use VuFind\Search\Base\Results;
 use VuFind\Search\Results\PluginManager;
 use VuFind\Search\SearchTabsHelper;
 use VuFind\Search\UrlQueryHelper;
+use VuFind\ServiceManager\Factory\Autowire;
 
 /**
  * "Search tabs" view helper
@@ -48,37 +49,9 @@
  * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
  * @link     https://vufind.org/wiki/development Wiki
  */
-class SearchTabs extends \Laminas\View\Helper\AbstractHelper implements \Psr\Log\LoggerAwareInterface
+class SearchTabs implements LoggerAwareInterface
 {
-    use \VuFind\Log\LoggerAwareTrait;
-
-    /**
-     * Search manager
-     *
-     * @var PluginManager
-     */
-    protected $results;
-
-    /**
-     * Request
-     *
-     * @var Request
-     */
-    protected $request;
-
-    /**
-     * Url
-     *
-     * @var Url
-     */
-    protected $url;
-
-    /**
-     * Search tab helper
-     *
-     * @var SearchTabsHelper
-     */
-    protected $helper;
+    use LoggerAwareTrait;
 
     /**
      * Cached hidden filter url params
@@ -97,18 +70,29 @@ class SearchTabs extends \Laminas\View\Helper\AbstractHelper implements \Psr\Log
     /**
      * Constructor
      *
-     * @param PluginManager    $results Search results plugin manager
-     * @param Url              $url     URL helper
-     * @param SearchTabsHelper $helper  Search tabs helper
+     * @param PluginManager    $results      Search results plugin manager
+     * @param Url              $url          URL helper
+     * @param SearchTabsHelper $helper       Search tabs helper
+     * @param SearchMemory     $searchMemory Search memory view helper
      */
     public function __construct(
-        PluginManager $results,
-        Url $url,
-        SearchTabsHelper $helper
+        protected PluginManager $results,
+        #[Autowire(container: 'ViewHelperManager')]
+        protected Url $url,
+        protected SearchTabsHelper $helper,
+        #[Autowire(container: 'ViewHelperManager')]
+        protected SearchMemory $searchMemory
     ) {
-        $this->results = $results;
-        $this->url = $url;
-        $this->helper = $helper;
+    }
+
+    /**
+     * Invoke the helper.
+     *
+     * @return static
+     */
+    public function __invoke(): static
+    {
+        return $this;
     }
 
     /**
@@ -135,18 +119,15 @@ public function getTabConfig(
         $allSettings = $this->helper->getSettings();
         $retVal['showCounts'] = $allSettings['show_result_counts'] ?? false;
         foreach ($this->helper->getTabConfig() as $key => $label) {
-            $permissionName = null;
-            if (isset($allPermissions[$key])) {
-                $permissionName = $allPermissions[$key];
-            }
+            $permissionName = $allPermissions[$key] ?? null;
             $class = $this->helper->extractClassName($key);
             $filters = isset($allFilters[$key]) ? (array)$allFilters[$key] : [];
-            $selected = $class == $activeSearchClass && $this->helper->filtersMatch($class, $hiddenFilters, $filters);
+            $selected = $class == $activeSearchClass
+                && $this->helper->filtersMatch($class, $hiddenFilters, $filters);
             try {
                 if ($type == 'basic') {
                     if (!isset($activeOptions)) {
-                        $activeOptions
-                            = $this->results->get($activeSearchClass)->getOptions();
+                        $activeOptions = $this->results->get($activeSearchClass)->getOptions();
                     }
                     $url = $this->remapBasicSearch(
                         $activeOptions,
@@ -262,14 +243,12 @@ public function getCurrentHiddenFilterParams(
             return '';
         }
         if (!isset($this->cachedHiddenFilterParams[$searchClassId])) {
-            $view = $this->getView();
             $hiddenFilters = $this->getHiddenFilters(
                 $searchClassId,
                 $ignoreHiddenFilterMemory
             );
             if (empty($hiddenFilters) && !$ignoreHiddenFilterMemory) {
-                $hiddenFilters = $view->plugin('searchMemory')
-                    ->getLastHiddenFilters($searchClassId);
+                $hiddenFilters = $this->searchMemory->getLastHiddenFilters($searchClassId);
                 if (empty($hiddenFilters)) {
                     $hiddenFilters = $this->getHiddenFilters($searchClassId);
                 }
@@ -323,15 +302,14 @@ protected function remapBasicSearch(
         foreach ($filters as $filter) {
             $params->addHiddenFilter($filter);
         }
-
         // Find matching handler for new query (and use default if no match):
         $options = $results->getOptions();
         $targetHandler = $options->getHandlerForLabel(
             $activeOptions->getLabelForBasicHandler($handler)
         );
 
         // Build new URL:
-        $results->getParams()->setBasicSearch($query, $targetHandler);
+        $params->setBasicSearch($query, $targetHandler);
         return ($this->url)($options->getSearchAction())
             . $results->getUrlQuery()->getParams(false);
     }
@@ -346,12 +324,9 @@ protected function remapBasicSearch(
      */
     protected function getHomeTabUrl($class, $filters)
     {
-        // If an advanced search is available, link there; otherwise, just go
-        // to the search home:
         $results = $this->results->get($class);
-        $url = ($this->url)($results->getOptions()->getSearchHomeAction())
+        return ($this->url)($results->getOptions()->getSearchHomeAction())
             . $this->buildUrlHiddenFilters($results, $filters);
-        return $url;
     }
 
     /**