[5.1] Convert mod_stats_admin to service provider (#42886)

* Convert mod_stats_admin to service provider

Author: joomlaweby

administrator/modules/mod_stats_admin/mod_stats_admin.php

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

administrator/modules/mod_stats_admin/mod_stats_admin.xml

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  mod_stats_admin
+ *
+ * @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 statistics administrator 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\\StatsAdmin'));
+        $container->registerServiceProvider(new HelperFactory('\\Joomla\\Module\\StatsAdmin\\Administrator\\Helper'));
+
+        $container->registerServiceProvider(new Module());
+    }
+};

administrator/modules/mod_stats_admin/services/provider.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  mod_stats_admin
+ *
+ * @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\StatsAdmin\Administrator\Dispatcher;
+
+use Joomla\CMS\Dispatcher\AbstractModuleDispatcher;
+use Joomla\CMS\Factory;
+use Joomla\CMS\Helper\HelperFactoryAwareInterface;
+use Joomla\CMS\Helper\HelperFactoryAwareTrait;
+use Joomla\Database\DatabaseInterface;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Dispatcher class for mod_stats_admin
+ *
+ * @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();
+
+        $data['serverinfo'] = $data['params']->get('serverinfo');
+        $data['siteinfo']   = $data['params']->get('siteinfo');
+        $data['list']       = $this->getHelperFactory()->getHelper('StatsAdminHelper')->getStatsData($data['params'], $this->getApplication(), Factory::getContainer()->get(DatabaseInterface::class));
+
+        return $data;
+    }
+}

administrator/modules/mod_stats_admin/src/Dispatcher/Dispatcher.php

@@ -37,9 +37,9 @@ class StatsAdminHelper
      *
      * @return  array  Array containing site information
      *
-     * @since   3.0
+     * @since   __DEPLOY_VERSION__
      */
-    public static function getStats(Registry $params, CMSApplication $app, DatabaseInterface $db)
+    public function getStatsData(Registry $params, CMSApplication $app, DatabaseInterface $db)
     {
         $user = $app->getIdentity();
 
@@ -144,4 +144,26 @@ public static function getStats(Registry $params, CMSApplication $app, DatabaseI
 
         return $rows;
     }
+
+    /**
+     * Method to retrieve information about the site
+     *
+     * @param   Registry           $params  The module parameters
+     * @param   CMSApplication     $app     The application
+     * @param   DatabaseInterface  $db      The database
+     *
+     * @return  array  Array containing site information
+     *
+     * @since   3.0
+     *
+     * @deprecated __DEPLOY_VERSION__ will be removed in 6.0
+     *             Use the non-static method getStatsData
+     *             Example: Factory::getApplication()->bootModule('mod_stats_admin', 'administrator')
+     *                          ->getHelper('StatsAdminHelper')
+     *                          ->getStatsData($params, Factory::getApplication(), Factory::getContainer()->get(DatabaseInterface::class))
+     */
+    public static function getStats(Registry $params, CMSApplication $app, DatabaseInterface $db)
+    {
+        return (new self())->getStatsData($params, $app, $db);
+    }
 }