Convert mod_related_items to new structure (#39628)

* adding service provider

* adding the dispatcher

* declare main function

* Help class definition

* layout adaptation

* not used

* fix some errors

* adding cache

* cs fix

* update

* cs

* update

* revert Helper

* cy test

* cs

* javascript cs

* cy test without need article ID

* cache

* revert tmpl

* revert tmpl

* revert tmpl

* separate test code

Author: carlitorweb

modules/mod_related_items/mod_related_items.php

@@ -11,7 +11,7 @@
 	<description>MOD_RELATED_XML_DESCRIPTION</description>
 	<namespace path="src">Joomla\Module\RelatedItems</namespace>
 	<files>
-		<filename module="mod_related_items">mod_related_items.php</filename>
+		<folder module="mod_related_items">services</folder>
 		<folder>src</folder>
 		<folder>tmpl</folder>
 	</files>

modules/mod_related_items/mod_related_items.xml

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  mod_related_items
+ *
+ * @copyright   (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+defined('_JEXEC') or die;
+
+use Joomla\CMS\Extension\Service\Provider\HelperFactory;
+use Joomla\CMS\Extension\Service\Provider\Module;
+use Joomla\CMS\Extension\Service\Provider\ModuleDispatcherFactory;
+use Joomla\DI\Container;
+use Joomla\DI\ServiceProviderInterface;
+
+/**
+ * The articles related module service provider.
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+return new class () implements ServiceProviderInterface {
+    /**
+     * Registers the service provider with a DI container.
+     *
+     * @param   Container  $container  The DI container.
+     *
+     * @return  void
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function register(Container $container)
+    {
+        $container->registerServiceProvider(new ModuleDispatcherFactory('\\Joomla\\Module\\RelatedItems'));
+        $container->registerServiceProvider(new HelperFactory('\\Joomla\\Module\\RelatedItems\\Site\\Helper'));
+
+        $container->registerServiceProvider(new Module());
+    }
+};

modules/mod_related_items/services/provider.php

@@ -0,0 +1,55 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  mod_related_items
+ *
+ * @copyright   (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Module\RelatedItems\Site\Dispatcher;
+
+use Joomla\CMS\Dispatcher\AbstractModuleDispatcher;
+use Joomla\CMS\Helper\HelperFactoryAwareInterface;
+use Joomla\CMS\Helper\HelperFactoryAwareTrait;
+use Joomla\CMS\Helper\ModuleHelper;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('JPATH_PLATFORM') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Dispatcher class for mod_articles_popular
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class Dispatcher extends AbstractModuleDispatcher implements HelperFactoryAwareInterface
+{
+    use HelperFactoryAwareTrait;
+
+    /**
+     * Returns the layout data.
+     *
+     * @return  array
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    protected function getLayoutData(): array
+    {
+        $data   = parent::getLayoutData();
+        $params = $data['params'];
+
+        $cacheParams               = new \stdClass();
+        $cacheParams->cachemode    = 'safeuri';
+        $cacheParams->class        = $this->getHelperFactory()->getHelper('RelatedItemsHelper');
+        $cacheParams->method       = 'getRelatedArticles';
+        $cacheParams->methodparams = [$params, $data['app']];
+        $cacheParams->modeparams   = ['id' => 'int', 'Itemid' => 'int'];
+
+        $data['list']     = ModuleHelper::moduleCache($this->module, $params, $cacheParams);
+        $data['showDate'] = $params->get('showDate', 0);
+
+        return $data;
+    }
+}

modules/mod_related_items/src/Dispatcher/Dispatcher.php

@@ -10,13 +10,18 @@
 
 namespace Joomla\Module\RelatedItems\Site\Helper;
 
+use Joomla\CMS\Application\SiteApplication;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Language\Multilanguage;
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\Router\Route;
 use Joomla\Component\Content\Administrator\Extension\ContentComponent;
 use Joomla\Component\Content\Site\Helper\RouteHelper;
+use Joomla\Component\Content\Site\Model\ArticlesModel;
+use Joomla\Database\DatabaseAwareInterface;
+use Joomla\Database\DatabaseAwareTrait;
 use Joomla\Database\ParameterType;
+use Joomla\Registry\Registry;
 
 // phpcs:disable PSR1.Files.SideEffects
 \defined('_JEXEC') or die;
@@ -27,26 +32,30 @@
  *
  * @since  1.5
  */
-abstract class RelatedItemsHelper
+class RelatedItemsHelper implements DatabaseAwareInterface
 {
+    use DatabaseAwareTrait;
+
     /**
-     * Get a list of related articles
+     * Retrieve a list of related articles based on the metakey field
      *
-     * @param   \Joomla\Registry\Registry  &$params  module parameters
+     * @param   Registry         $params  The module parameters.
+     * @param   SiteApplication  $app     The current application.
      *
-     * @return  array
+     * @return  \stdClass[]
+     *
+     * @since   __DEPLOY_VERSION__
      */
-    public static function getList(&$params)
+    public function getRelatedArticles(Registry $params, SiteApplication $app): array
     {
-        $db        = Factory::getDbo();
-        $app       = Factory::getApplication();
+        $db        = $this->getDatabase();
         $input     = $app->getInput();
-        $groups    = Factory::getUser()->getAuthorisedViewLevels();
+        $groups    = $app->getIdentity()->getAuthorisedViewLevels();
         $maximum   = (int) $params->get('maximum', 5);
         $factory   = $app->bootComponent('com_content')->getMVCFactory();
 
         // Get an instance of the generic articles model
-        /** @var \Joomla\Component\Content\Site\Model\ArticlesModel $articles */
+        /** @var ArticlesModel $articles */
         $articles = $factory->createModel('Articles', 'Site', ['ignore_request' => true]);
 
         // Set application parameters in model
@@ -133,7 +142,7 @@ public static function getList(&$params)
 
                 // Filter by language
                 if (Multilanguage::isEnabled()) {
-                    $query->whereIn($db->quoteName('a.language'), [Factory::getLanguage()->getTag(), '*'], ParameterType::STRING);
+                    $query->whereIn($db->quoteName('a.language'), [$app->getLanguage()->getTag(), '*'], ParameterType::STRING);
                 }
 
                 $query->setLimit($maximum);
@@ -167,4 +176,27 @@ public static function getList(&$params)
 
         return $related;
     }
+
+    /**
+     * Get a list of related articles
+     *
+     * @param   Registry  &$params  module parameters
+     *
+     * @return  array
+     *
+     * @since   1.6
+     *
+     * @deprecated  __DEPLOY_VERSION__  will be removed in 6.0
+     *              Use the non-static method getRelatedArticles
+     *              Example: Factory::getApplication()->bootModule('mod_related_items', 'site')
+     *                           ->getHelper('RelatedItemsHelper')
+     *                           ->getRelatedArticles($params, Factory::getApplication())
+     */
+    public static function getList(&$params)
+    {
+        /** @var SiteApplication $app */
+        $app = Factory::getApplication();
+
+        return (new self())->getRelatedArticles($params, $app);
+    }
 }

modules/mod_related_items/src/Helper/RelatedItemsHelper.php

@@ -0,0 +1,13 @@
+describe('Test the related items module', () => {
+  it('can load in frontend showing a list of related articles based on the metakey field', () => {
+    cy.db_createArticle({ title: 'Main Article', metakey: 'joomla', featured: 1 })
+      .then(() => cy.db_createArticle({ title: 'article with joomla keyword', metakey: 'joomla' }))
+      .then(() => cy.db_createModule({ module: 'mod_related_items' }))
+      .then(() => {
+        cy.visit('/');
+        cy.contains('a', 'Main Article').click();
+
+        cy.contains('li', 'article with joomla keyword');
+      });
+  });
+});