Refactor Context View Helper to use Autowiring (#5096)

Author: sambhavp96

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

@@ -31,8 +31,8 @@
 
 namespace VuFind\View\Helper\Root;
 
-use Laminas\View\Helper\AbstractHelper;
 use Laminas\View\Renderer\RendererInterface;
+use VuFind\ServiceManager\Factory\Autowire;
 
 /**
  * Context manager (useful for using render() instead of partial() for better
@@ -45,8 +45,19 @@
  * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
  * @link     https://vufind.org/wiki/development Wiki
  */
-class Context extends AbstractHelper
+class Context
 {
+    /**
+     * Constructor
+     *
+     * @param RendererInterface $view View renderer
+     */
+    #[Autowire]
+    public function __construct(
+        protected RendererInterface $view
+    ) {
+    }
+
     /**
      * Set an array of variables in the view; return the previous values of those
      * variables so they can be restored.
@@ -57,12 +68,10 @@ class Context extends AbstractHelper
      */
     public function apply($vars)
     {
-        $view = $this->getView();
-
         $oldVars = [];
         foreach ($vars as $k => $v) {
-            $oldVars[$k] = $view->$k ?? null;
-            $view->$k = $v;
+            $oldVars[$k] = $this->view->$k ?? null;
+            $this->view->$k = $v;
         }
         return $oldVars;
     }
@@ -76,13 +85,11 @@ public function apply($vars)
      */
     public function restore($vars)
     {
-        $view = $this->getView();
-
         foreach ($vars as $k => $v) {
             if (null === $v) {
-                unset($view->$k);
+                unset($this->view->$k);
             } else {
-                $view->$k = $v;
+                $this->view->$k = $v;
             }
         }
     }
@@ -101,22 +108,22 @@ public function restore($vars)
     public function renderInContext($template, $context)
     {
         $oldContext = $this->apply($context);
-        $html = $this->getView()->render($template);
+        $html = $this->view->render($template);
         $this->restore($oldContext);
         return $html;
     }
 
     /**
-     * Grab the helper object, so we can call methods on it.
+     * Return this helper instance.
      *
-     * @param ?RendererInterface $view View object to modify.
+     * @param RendererInterface $view View Renderer
      *
      * @return Context
      */
     public function __invoke(?RendererInterface $view = null)
     {
         if (null !== $view) {
-            $this->setView($view);
+            $this->view = $view;
         }
         return $this;
     }

module/VuFind/tests/unit-tests/src/VuFindTest/View/Helper/Root/PermissionTest.php

@@ -222,11 +222,11 @@ protected function getMockView()
         $escapehtml = new \Laminas\View\Helper\EscapeHtml();
         $translate = new \VuFind\View\Helper\Root\Translate();
         $transEsc = new \VuFind\View\Helper\Root\TransEsc($translate, $escapehtml);
-        $context = new \VuFind\View\Helper\Root\Context();
         $realView = $this->getPhpRenderer(
-            compact('translate', 'transEsc', 'context', 'escapehtml')
+            compact('translate', 'transEsc', 'escapehtml')
         );
-        $context->setView($realView);
+        $context = new \VuFind\View\Helper\Root\Context($realView);
+        $realView->getHelperPluginManager()->setService('context', $context);
         return $realView;
     }
 }

module/VuFind/tests/unit-tests/src/VuFindTest/View/Helper/Root/RecordDataFormatterTest.php

@@ -81,14 +81,18 @@ protected function getMockRecordRouter(): MockObject&\VuFind\Record\Router
      */
     protected function getViewHelpers(ContainerInterface $container, SchemaOrg $schemaOrgHelper): array
     {
-        $context = new \VuFind\View\Helper\Root\Context();
+        $translate = new \VuFind\View\Helper\Root\Translate();
+        $escapeHtml = new \Laminas\View\Helper\EscapeHtml();
+        $transEsc = new \VuFind\View\Helper\Root\TransEsc($translate, $escapeHtml);
+        $helperArray = compact('translate', 'transEsc', 'escapeHtml');
+        $view = $this->getPhpRenderer($helperArray);
+        $context = new \VuFind\View\Helper\Root\Context($view);
         $record = new \VuFind\View\Helper\Root\Record($this->createMock(TagsService::class));
         $serviceManager = $this->createMock(\VuFind\Db\Service\PluginManager::class);
         $serviceManager->method('get')->willReturnCallback(function ($service) {
             return $this->createMock($service);
         });
         $record->setDbServiceManager($serviceManager);
-        $translate = new \VuFind\View\Helper\Root\Translate();
         return [
             'auth' => new \VuFind\View\Helper\Root\Auth(
                 $this->createMock(\VuFind\Auth\Manager::class),
@@ -119,7 +123,7 @@ protected function getViewHelpers(ContainerInterface $container, SchemaOrg $sche
                 new \VuFind\Search\Options\PluginManager($container)
             ),
             'searchTabs' => $this->createMock(\VuFind\View\Helper\Root\SearchTabs::class),
-            'transEsc' => new \VuFind\View\Helper\Root\TransEsc($translate, new \Laminas\View\Helper\EscapeHtml()),
+            'transEsc' => $transEsc,
             'translate' => $translate,
             'usertags' => new \VuFind\View\Helper\Root\UserTags(),
         ];

themes/root/theme.config.php

@@ -24,7 +24,6 @@
             'VuFind\View\Helper\Root\CookieConsent' => 'VuFind\View\Helper\Root\CookieConsentFactory',
             'VuFind\View\Helper\Root\CookieManager' => 'VuFind\View\Helper\Root\CookieManagerFactory',
             'VuFind\View\Helper\Root\ContentBlock' => 'Laminas\ServiceManager\Factory\InvokableFactory',
-            'VuFind\View\Helper\Root\Context' => 'Laminas\ServiceManager\Factory\InvokableFactory',
             'VuFind\View\Helper\Root\Csp' => 'VuFind\View\Helper\Root\CspFactory',
             'VuFind\View\Helper\Root\CurrentPath' => 'Laminas\ServiceManager\Factory\InvokableFactory',
             'VuFind\View\Helper\Root\DateTime' => 'VuFind\View\Helper\Root\DateTimeFactory',