Use component view helper for Finna components

NatLibFi · Jul 31, 2023 · ef1ac9b · ef1ac9b
1 parent ac00937
commit ef1ac9b
Show file tree

Hide file tree

Showing 10 changed files with 82 additions and 17 deletions.
diff --git a/module/Finna/src/Finna/View/Helper/Root/Component.php b/module/Finna/src/Finna/View/Helper/Root/Component.php
@@ -0,0 +1,63 @@
+<?php
+
+/**
+ * Component view helper
+ *
+ * PHP version 8
+ *
+ * Copyright (C) The National Library of Finland 2023.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * @category VuFind
+ * @package  View_Helpers
+ * @author   Aleksi Peebles <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development Wiki
+ */
+
+namespace Finna\View\Helper\Root;
+
+/**
+ * Component view helper
+ *
+ * @category VuFind
+ * @package  View_Helpers
+ * @author   Aleksi Peebles <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development Wiki
+ */
+class Component extends \VuFind\View\Helper\Root\Component
+{
+    /**
+     * Expand path and render template
+     *
+     * @param string $name   Component name that matches a template
+     * @param array  $params Data for the component template
+     *
+     * @return string
+     */
+    public function __invoke(string $name, $params = []): string
+    {
+        if ($name[0] !== '@') {
+            return parent::__invoke($name, $params);
+        }
+
+        $parts = explode('/', $name);
+        $path = substr(array_shift($parts), 1);
+        $name = implode('/', $parts);
+
+        return $this->view->render("components/$path/" . $name, $params);
+    }
+}
diff --git a/themes/finna2/templates/Helpers/bazaar-browse-bar.phtml b/themes/finna2/templates/Helpers/bazaar-browse-bar.phtml
@@ -1,5 +1,5 @@
 <!-- START of: finna - Helpers/bazaar-browse-bar.phtml -->
-<?= $this->render('components/organisms/navigation/finna-bazaar-browse-bar', [
+<?= $this->component('@organisms/navigation/finna-bazaar-browse-bar', [
     'addResourceCallbackPayload' => $this->bazaarSession()->getAddResourceCallbackPayload(),
     'addResourceCallbackUrl' => $this->bazaarSession()->getAddResourceCallbackUrl(),
     'cancelUrl' => $this->bazaarSession()->getCancelUrl(),

diff --git a/themes/finna2/templates/RecordDriver/DefaultRecord/list-entry.phtml b/themes/finna2/templates/RecordDriver/DefaultRecord/list-entry.phtml
@@ -150,7 +150,7 @@
           <div class="note-info <?= $notes ? '' : ' hide' ?>"><strong><?=$this->transEsc('Note')?>:</strong></div>
           <?php if ($list_id): ?>
             <?php $markdown = $notes ? $this->markdown()->replaceDeprecatedTags($notes) : ''; ?>
-            <?= $this->render('components/organisms/widgets/finna-md-editable', [
+            <?= $this->component('@organisms/widgets/finna-md-editable', [
                 'attributes' => ['class' => 'resource-note'],
                 'markdown' => $markdown,
                 'html' => $markdown ? $this->markdown()->toHtml($markdown, false) : '',

diff --git a/themes/finna2/templates/RecordDriver/EDS/list-entry.phtml b/themes/finna2/templates/RecordDriver/EDS/list-entry.phtml
@@ -125,7 +125,7 @@
           <div class="note-info <?= $notes ? '' : ' hide' ?>"><strong><?=$this->transEsc('Note')?>:</strong></div>
           <?php if ($list_id): ?>
             <?php $markdown = $notes ? $this->markdown()->replaceDeprecatedTags($notes) : ''; ?>
-            <?= $this->render('components/organisms/widgets/finna-md-editable', [
+            <?= $this->component('@organisms/widgets/finna-md-editable', [
                 'attributes' => ['class' => 'resource-note'],
                 'markdown' => $markdown,
                 'html' => $markdown ? $this->markdown()->toHtml($markdown, false) : '',

diff --git a/themes/finna2/templates/RecordDriver/Primo/list-entry.phtml b/themes/finna2/templates/RecordDriver/Primo/list-entry.phtml
@@ -125,7 +125,7 @@
           <div class="note-info <?= $notes ? '' : ' hide' ?>"><strong><?=$this->transEsc('Note')?>:</strong></div>
           <?php if ($list_id): ?>
             <?php $markdown = $notes ? $this->markdown()->replaceDeprecatedTags($notes) : ''; ?>
-            <?= $this->render('components/organisms/widgets/finna-md-editable', [
+            <?= $this->component('@organisms/widgets/finna-md-editable', [
                 'attributes' => ['class' => 'resource-note'],
                 'markdown' => $markdown,
                 'html' => $markdown ? $this->markdown()->toHtml($markdown, false) : '',

diff --git a/themes/finna2/templates/RecordDriver/SolrLido/list-entry.phtml b/themes/finna2/templates/RecordDriver/SolrLido/list-entry.phtml
@@ -145,7 +145,7 @@
           <div class="note-info <?= $notes ? '' : ' hide' ?>"><strong><?=$this->transEsc('Note')?>:</strong></div>
           <?php if ($list_id): ?>
             <?php $markdown = $notes ? $this->markdown()->replaceDeprecatedTags($notes) : ''; ?>
-            <?= $this->render('components/organisms/widgets/finna-md-editable', [
+            <?= $this->component('@organisms/widgets/finna-md-editable', [
                 'attributes' => ['class' => 'resource-note'],
                 'markdown' => $markdown,
                 'html' => $markdown ? $this->markdown()->toHtml($markdown, false) : '',

diff --git a/themes/finna2/templates/myresearch/mylist.phtml b/themes/finna2/templates/myresearch/mylist.phtml
@@ -58,7 +58,7 @@
           </div>
         <?php endif; ?>
         <?php $markdown = $list ? $this->markdown()->replaceDeprecatedTags($list->description ?? '') : ''; ?>
-        <?= $this->render('components/organisms/widgets/finna-md-editable', [
+        <?= $this->component('@organisms/widgets/finna-md-editable', [
             'attributes' => ['class' => 'list-description'],
             'markdown' => $markdown,
             'html' => $markdown ? $this->markdown()->toHtml($markdown, false) : '',

diff --git a/themes/finna2/templates/organisationinfo/home-consortium.phtml b/themes/finna2/templates/organisationinfo/home-consortium.phtml
@@ -35,7 +35,7 @@
             </div>
           </div>
         <?php $content = ob_get_clean(); ?>
-        <?= $this->render('components/molecules/containers/finna-panel', [
+        <?= $this->component('@molecules/containers/finna-panel', [
             'attributes' => ['class' => ['finna-panel-default', 'organisation-info-panel']],
             'heading' => $this->transEsc('organisation_info_navi_usage'),
             'headingLevel' => 4,
@@ -57,7 +57,7 @@
             </ul>
           </div>
         <?php $content = ob_get_clean(); ?>
-        <?= $this->render('components/molecules/containers/finna-panel', [
+        <?= $this->component('@molecules/containers/finna-panel', [
             'attributes' => ['class' => ['finna-panel-default', 'organisation-info-panel', 'links-panel', 'hide']],
             'heading' => $this->transEsc('Links'),
             'headingLevel' => 4,

diff --git a/themes/finna2/templates/organisationinfo/map-information.phtml b/themes/finna2/templates/organisationinfo/map-information.phtml
@@ -89,7 +89,7 @@
         <p class="building-year info-element"><?=$this->transEsc('organisation_info_building_year')?>: <span></span></p>
         <p class="office-description description-long info-element" data-truncate="<?=$this->htmlSafeJsonEncode(['rows' => 5])?>"></p>
       <?php $content = ob_get_clean(); ?>
-      <?= $this->render('components/molecules/containers/finna-panel', [
+      <?= $this->component('@molecules/containers/finna-panel', [
           'attributes' => ['class' => ['finna-panel-borderless', 'introduction']],
           'heading' => $this->transEsc('organisation_info_general'),
           'headingLevel' => 4,
@@ -100,7 +100,7 @@
         ]); ?>
     </div>
     <div class="office-col opening-times-widget">
-      <?= $this->render('components/molecules/containers/finna-panel', [
+      <?= $this->component('@molecules/containers/finna-panel', [
           'attributes' => ['class' => ['finna-panel-borderless', 'opening-times-library-information']],
           'heading' => $this->transEsc('organisation_info_schedules'),
           'headingLevel' => 4,
@@ -111,7 +111,7 @@
         ]); ?>
     </div>
     <div class="office-col">
-      <?= $this->render('components/molecules/containers/finna-panel', [
+      <?= $this->component('@molecules/containers/finna-panel', [
           'attributes' => ['class' => ['finna-panel-borderless', 'contact-details', 'contact-details-rss', 'info-element']],
           'heading' => $this->transEsc('organisation_info_contact'),
           'headingLevel' => 4,
@@ -120,7 +120,7 @@
           'collapseId' => 'collapse3',
           'collapsed' => false,
         ]); ?>
-      <?= $this->render('components/molecules/containers/finna-panel', [
+      <?= $this->component('@molecules/containers/finna-panel', [
           'attributes' => ['class' => ['finna-panel-borderless', 'contact-details', 'contact-details-no-rss', 'info-element']],
           'heading' => $this->transEsc('organisation_info_contact'),
           'headingLevel' => 4,
@@ -142,7 +142,7 @@
     <h5 class="service-header collection hidden"><?= $this->transEsc('Collections') ?></h5>
     <div class="service-list collection"></div>
   <?php $content = ob_get_clean(); ?>
-  <?= $this->render('components/molecules/containers/finna-panel', [
+  <?= $this->component('@molecules/containers/finna-panel', [
       'attributes' => ['class' => ['finna-panel-borderless', 'services', 'info-element']],
       'heading' => $this->transEsc('organisation_info_services'),
       'headingLevel' => 4,
@@ -152,7 +152,7 @@
       'collapsed' => false,
     ]); ?>
   <?php // Accessibility information ?>
-  <?= $this->render('components/molecules/containers/finna-panel', [
+  <?= $this->component('@molecules/containers/finna-panel', [
       'attributes' => ['class' => ['finna-panel-borderless', 'accessibility-details', 'info-element']],
       'heading' => $this->transEsc('organisation_info_accessibility'),
       'headingLevel' => 4,
@@ -179,7 +179,7 @@
       </table>
     </div>
   <?php $content = ob_get_clean(); ?>
-  <?= $this->render('components/molecules/containers/finna-panel', [
+  <?= $this->component('@molecules/containers/finna-panel', [
       'attributes' => ['class' => ['finna-panel-borderless', 'personnel', 'info-element']],
       'heading' => $this->transEsc('organisation_info_staff'),
       'headingLevel' => 4,
@@ -192,7 +192,7 @@
     <?php ob_start(); ?>
       <div class="feed-container news-feed info-element" data-init="0"></div>
     <?php $content = ob_get_clean(); ?>
-    <?= $this->render('components/molecules/containers/finna-panel', [
+    <?= $this->component('@molecules/containers/finna-panel', [
         'attributes' => ['class' => ['finna-panel-borderless', 'news-feed-container', 'rss-container', 'info-element']],
         'heading' => $this->transEsc('organisation_info_rss_news'),
         'headingLevel' => 4,
@@ -203,7 +203,7 @@
     <?php ob_start(); ?>
       <div class="feed-container events-feed info-element" data-init="0"></div>
     <?php $content = ob_get_clean(); ?>
-    <?= $this->render('components/molecules/containers/finna-panel', [
+    <?= $this->component('@molecules/containers/finna-panel', [
         'attributes' => ['class' => ['finna-panel-borderless', 'events-feed-container', 'rss-container', 'info-element']],
         'heading' => $this->transEsc('organisation_info_rss_events'),
         'headingLevel' => 4,

diff --git a/themes/finna2/theme.config.php b/themes/finna2/theme.config.php
@@ -16,6 +16,7 @@
             'Finna\View\Helper\Root\Citation' => 'Finna\View\Helper\Root\CitationFactory',
             'Finna\View\Helper\Root\CleanHtml' => 'Finna\View\Helper\Root\CleanHtmlFactory',
             'Finna\View\Helper\Root\Combined' => 'Finna\View\Helper\Root\CombinedFactory',
+            'Finna\View\Helper\Root\Component' => 'Laminas\ServiceManager\Factory\InvokableFactory',
             'Finna\View\Helper\Root\Config' => 'VuFind\View\Helper\Root\ConfigFactory',
             'Finna\View\Helper\Root\Content' => 'Laminas\ServiceManager\Factory\InvokableFactory',
             'Finna\View\Helper\Root\Cookie' => 'Finna\View\Helper\Root\CookieFactory',
@@ -86,6 +87,7 @@
             'callnumber' => 'Finna\View\Helper\Root\Callnumber',
             'cleanHtml' => 'Finna\View\Helper\Root\CleanHtml',
             'combined' => 'Finna\View\Helper\Root\Combined',
+            'component' => 'Finna\View\Helper\Root\Component',
             'content' => 'Finna\View\Helper\Root\Content',
             'cookie' => 'Finna\View\Helper\Root\Cookie',
             'cookieConsent' => 'Finna\View\Helper\Root\CookieConsent',