[5.1] Convert mod_tags_similar to service provider (#42898)

Author: joomlaweby

modules/mod_tags_similar/mod_tags_similar.php

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

modules/mod_tags_similar/mod_tags_similar.xml

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  mod_tags_similar
+ *
+ * @copyright   (C) 2024 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 tags similar 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): void
+    {
+        $container->registerServiceProvider(new ModuleDispatcherFactory('\\Joomla\\Module\\TagsSimilar'));
+        $container->registerServiceProvider(new HelperFactory('\\Joomla\\Module\\TagsSimilar\\Site\\Helper'));
+
+        $container->registerServiceProvider(new Module());
+    }
+};

modules/mod_tags_similar/services/provider.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  mod_tags_similar
+ *
+ * @copyright   (C) 2024 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Module\TagsSimilar\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('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Dispatcher class for mod_tags_similar
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class Dispatcher extends AbstractModuleDispatcher implements HelperFactoryAwareInterface
+{
+    use HelperFactoryAwareTrait;
+
+    /**
+     * Returns the layout data.
+     *
+     * @return  array
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    protected function getLayoutData()
+    {
+        $data = parent::getLayoutData();
+
+        $cacheparams               = new \stdClass();
+        $cacheparams->cachemode    = 'safeuri';
+        $cacheparams->class        = $this->getHelperFactory()->getHelper('TagsSimilarHelper');
+        $cacheparams->method       = 'getItems';
+        $cacheparams->methodparams = $data['params'];
+        $cacheparams->modeparams   = ['id' => 'array', 'Itemid' => 'int'];
+
+        $data['list'] = ModuleHelper::moduleCache($this->module, $data['params'], $cacheparams);
+
+        return $data;
+    }
+}

modules/mod_tags_similar/src/Dispatcher/Dispatcher.php

@@ -16,6 +16,8 @@
 use Joomla\CMS\Helper\TagsHelper;
 use Joomla\CMS\Language\Text;
 use Joomla\Component\Tags\Site\Helper\RouteHelper;
+use Joomla\Database\DatabaseAwareInterface;
+use Joomla\Database\DatabaseAwareTrait;
 use Joomla\Database\ParameterType;
 use Joomla\Registry\Registry;
 
@@ -28,16 +30,20 @@
  *
  * @since  3.1
  */
-abstract class TagsSimilarHelper
+class TagsSimilarHelper implements DatabaseAwareInterface
 {
+    use DatabaseAwareTrait;
+
     /**
-     * Get a list of tags
+     * Get a list of items with similar tags
      *
      * @param   Registry  &$params  Module parameters
      *
      * @return  array
+     *
+     * @since   __DEPLOY_VERSION__
      */
-    public static function getList(&$params)
+    public function getItems(&$params)
     {
         $app    = Factory::getApplication();
         $option = $app->getInput()->get('option');
@@ -49,8 +55,8 @@ public static function getList(&$params)
             return [];
         }
 
-        $db         = Factory::getDbo();
-        $user       = Factory::getUser();
+        $db         = $this->getDatabase();
+        $user       = $app->getIdentity();
         $groups     = $user->getAuthorisedViewLevels();
         $matchtype  = $params->get('matchtype', 'all');
         $ordering   = $params->get('ordering', 'count');
@@ -218,4 +224,22 @@ public static function getList(&$params)
 
         return $results;
     }
+
+    /**
+     * Get a list of items with similar tags
+     *
+     * @param   Registry  &$params  Module parameters
+     *
+     * @return  array
+     *
+     * @deprecated __DEPLOY_VERSION__ will be removed in 6.0
+     *             Use the non-static method getItems
+     *             Example: Factory::getApplication()->bootModule('mod_tags_similar', 'site')
+     *                          ->getHelper('TagsSimilarHelper')
+     *                          ->getItems($params)
+     */
+    public static function getList(&$params)
+    {
+        return (new self())->getItems($params);
+    }
 }