[VUFIND-1677] Prepare for laminas-view v3

composer.json

@@ -84,7 +84,7 @@
         "laminas/laminas-session": "2.21.0",
         "laminas/laminas-stdlib": "3.19.0",
         "laminas/laminas-validator": "2.64.2",
-        "laminas/laminas-view": "2.27.0",
+        "laminas/laminas-view": "2.36.0",
         "laminas/laminas-translator": "^1",
         "league/commonmark": "2.6.0",
         "league/oauth2-client": "^2.7",

config/vufind/config.ini

@@ -55,9 +55,9 @@ theme           = sandal5
 ; Uncomment the following line to use a different theme for Admin module.
 ;admin_theme     = sandal
 
-; Automatic asset minification and concatenation setting. When active, HeadScript
-; and HeadLink will concatenate and minify all viable files to reduce requests and
-; load times. This setting is off by default.
+; Automatic asset minification and concatenation setting. When active, the asset
+; manager helper will concatenate and minify all viable files to reduce requests
+; and load times. This setting is off by default.
 ;
 ; This configuration takes the form of a semi-colon separated list of
 ; environment:configuration pairs where "environment" is a possible APPLICATION_ENV

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

@@ -29,8 +29,6 @@
 
 namespace VuFind\View\Helper\Root;
 
-use Laminas\View\Helper\HeadScript;
-
 use function is_array;
 
 /**
@@ -107,11 +105,11 @@ public function __invoke($customUrl = false)
         if (!$this->key) {
             return '';
         }
-        $inlineScript = $this->getView()->plugin('inlinescript');
+        $assetManager = $this->getView()->plugin('assetManager');
         $url = 'https://www.googletagmanager.com/gtag/js?id=' . urlencode($this->key);
         $code = $this->getRawJavascript($customUrl);
         return
-            $inlineScript(HeadScript::FILE, $url, 'SET', ['async' => true]) . "\n"
-            . $inlineScript(HeadScript::SCRIPT, $code, 'SET');
+            $assetManager->outputInlineScriptFile($url, attrs: ['async' => true]) . "\n"
+            . $assetManager->outputInlineScript($code);
     }
 }

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

@@ -68,7 +68,6 @@ public function getHeadCode()
             return '';
         }
 
-        // phpcs:disable -- line length should be kept for this vendor snippet
         $js = <<<END
             (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
             new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
@@ -77,10 +76,7 @@ public function getHeadCode()
             n&&j.setAttribute('nonce',n.nonce||n.getAttribute('nonce'));f.parentNode.insertBefore(j,f);
             })(window,document,'script','dataLayer','{$this->gtmContainerId}');
             END;
-        // phpcs:enable
-        $inlineScript = $this->getView()->plugin('inlinescript');
-        $js = $inlineScript(\Laminas\View\Helper\HeadScript::SCRIPT, $js, 'SET');
-        return $js;
+        return $this->getView()->plugin('assetManager')->outputInlineScript($js);
     }
 
     /**
@@ -94,14 +90,12 @@ public function getBodyCode()
             return '';
         }
 
-        // phpcs:disable -- line length should be kept for this vendor snippet
         $js = <<<END
             <!-- Google Tag Manager (noscript) -->
             <noscript><iframe src="https://www.googletagmanager.com/ns.html?id={$this->gtmContainerId}"
             height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
             <!-- End Google Tag Manager (noscript) -->
             END;
-        // phpcs:enable
         return $js;
     }
 }

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

@@ -177,9 +177,7 @@ public function __invoke(array $params = []): string
         } else {
             $code = $this->trackPageView();
         }
-
-        $inlineScript = $this->getView()->plugin('inlinescript');
-        return $inlineScript(\Laminas\View\Helper\HeadScript::SCRIPT, $code, 'SET');
+        return $this->getView()->plugin('assetManager')->outputInlineScript($code);
     }
 
     /**

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

@@ -174,8 +174,7 @@ public function __invoke($params = null)
             $code = $this->trackPageView();
         }
 
-        $inlineScript = $this->getView()->plugin('inlinescript');
-        return $inlineScript(\Laminas\View\Helper\HeadScript::SCRIPT, $code, 'SET');
+        return $this->getView()->plugin('assetManager')->outputInlineScript($code);
     }
 
     /**

module/VuFind/src/VuFindTest/Feature/ViewTrait.php

@@ -29,7 +29,11 @@
 
 namespace VuFindTest\Feature;
 
+use Laminas\View\Renderer\PhpRenderer;
 use VuFind\View\Helper\Root\SearchMemory;
+use VuFindTest\Container\MockContainer;
+use VuFindTheme\View\Helper\AssetManager;
+use VuFindTheme\View\Helper\AssetManagerFactory;
 
 /**
  * Trait for tests involving Laminas Views.
@@ -42,13 +46,29 @@
  */
 trait ViewTrait
 {
+    /**
+     * Get a working AssetManager helper.
+     *
+     * @param PhpRenderer $renderer View for helper
+     *
+     * @return AssetManager
+     */
+    protected function getAssetManager(PhpRenderer $renderer): AssetManager
+    {
+        $container = new MockContainer($this);
+        $factory = new AssetManagerFactory();
+        $helper = $factory($container, AssetManager::class);
+        $helper->setView($renderer);
+        return $helper;
+    }
+
     /**
      * Get a working renderer.
      *
      * @param array  $plugins Custom VuFind plug-ins to register
      * @param string $theme   Theme directory to load from
      *
-     * @return \Laminas\View\Renderer\PhpRenderer
+     * @return PhpRenderer
      */
     protected function getPhpRenderer($plugins = [], $theme = 'bootstrap5')
     {
@@ -63,13 +83,14 @@ protected function getPhpRenderer($plugins = [], $theme = 'bootstrap5')
                 $this->getPathForTheme($theme),
             ]
         );
-        $renderer = new \Laminas\View\Renderer\PhpRenderer();
+        $renderer = new PhpRenderer();
         $renderer->setResolver($resolver);
-        if (!empty($plugins)) {
-            $pluginManager = $renderer->getHelperPluginManager();
-            foreach ($plugins as $key => $value) {
-                $pluginManager->setService($key, $value);
-            }
+        $pluginManager = $renderer->getHelperPluginManager();
+        if (!isset($plugins['assetManager'])) {
+            $plugins['assetManager'] = $this->getAssetManager($renderer);
+        }
+        foreach ($plugins as $key => $value) {
+            $pluginManager->setService($key, $value);
         }
         return $renderer;
     }

module/VuFindTheme/Module.php

@@ -87,8 +87,8 @@ public function getServiceConfig()
                 ParentInjectTemplateListener::class => InjectTemplateListener::class,
             ],
             'factories' => [
-                InjectTemplateListener::class =>
-                    InjectTemplateListenerFactory::class,
+                AssetPipeline::class => AssetPipelineFactory::class,
+                InjectTemplateListener::class => InjectTemplateListenerFactory::class,
                 MixinGenerator::class => ThemeInfoInjectorFactory::class,
                 Mobile::class => InvokableFactory::class,
                 ResourceContainer::class => InvokableFactory::class,
@@ -108,34 +108,18 @@ public function getViewHelperConfig()
     {
         return [
             'factories' => [
-                View\Helper\FootScript::class =>
-                    View\Helper\PipelineInjectorFactory::class,
+                View\Helper\AssetManager::class => View\Helper\AssetManagerFactory::class,
                 View\Helper\ImageLink::class => View\Helper\ImageLinkFactory::class,
-                View\Helper\HeadLink::class =>
-                    View\Helper\PipelineInjectorFactory::class,
-                View\Helper\HeadScript::class =>
-                    View\Helper\PipelineInjectorFactory::class,
-                View\Helper\ParentTemplate::class =>
-                    View\Helper\ParentTemplateFactory::class,
-                View\Helper\InlineScript::class =>
-                    View\Helper\PipelineInjectorFactory::class,
-                View\Helper\Slot::class =>
-                    View\Helper\PipelineInjectorFactory::class,
-                View\Helper\TemplatePath::class =>
-                    View\Helper\TemplatePathFactory::class,
-                View\Helper\SetupThemeResources::class =>
-                    View\Helper\SetupThemeResourcesFactory::class,
+                View\Helper\ParentTemplate::class => View\Helper\ParentTemplateFactory::class,
+                View\Helper\Slot::class => InvokableFactory::class,
+                View\Helper\TemplatePath::class => View\Helper\TemplatePathFactory::class,
+                View\Helper\SetupThemeResources::class => View\Helper\SetupThemeResourcesFactory::class,
             ],
             'aliases' => [
-                'footScript' => View\Helper\FootScript::class,
+                'assetManager' => View\Helper\AssetManager::class,
                 // Legacy alias for compatibility with pre-8.0 templates:
                 'headThemeResources' => View\Helper\SetupThemeResources::class,
                 'imageLink' => View\Helper\ImageLink::class,
-                \Laminas\View\Helper\HeadLink::class => View\Helper\HeadLink::class,
-                \Laminas\View\Helper\HeadScript::class =>
-                    View\Helper\HeadScript::class,
-                \Laminas\View\Helper\InlineScript::class =>
-                    View\Helper\InlineScript::class,
                 'parentTemplate' => View\Helper\ParentTemplate::class,
                 'slot' => View\Helper\Slot::class,
                 'templatePath' => View\Helper\TemplatePath::class,