[5.3] Convert administrator mod_feed to service provider (#44819)

* Convert administrator mod_feed to service provider

* years in dokblocks fixed

* JFeedReader changed to Feed in docblocks

* injected FeedFactory

---------

Co-authored-by: Richard Fath <[email protected]>
Co-authored-by: Allon Moritz <[email protected]>

Author: 3 people

administrator/modules/mod_feed/mod_feed.php

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

administrator/modules/mod_feed/mod_feed.xml

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  mod_feed
+ *
+ * @copyright   (C) 2025 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 feed 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\\Feed'));
+        $container->registerServiceProvider(new HelperFactory('\\Joomla\\Module\\Feed\\Administrator\\Helper'));
+
+        $container->registerServiceProvider(new Module());
+    }
+};

administrator/modules/mod_feed/services/provider.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  mod_feed
+ *
+ * @copyright   (C) 2025 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Module\Feed\Administrator\Dispatcher;
+
+use Joomla\CMS\Dispatcher\AbstractModuleDispatcher;
+use Joomla\CMS\Feed\FeedFactory;
+use Joomla\CMS\Helper\HelperFactoryAwareInterface;
+use Joomla\CMS\Helper\HelperFactoryAwareTrait;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Dispatcher class for mod_feed
+ *
+ * @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();
+        $feedFactory = new FeedFactory();
+
+        $data['feed']   = $this->getHelperFactory()->getHelper('FeedHelper')->getFeedData($data['params'], $feedFactory);
+        $data['rssurl'] = $data['params']->get('rssurl', '');
+        $data['rssrtl'] = $data['params']->get('rssrtl', 0);
+
+        return $data;
+    }
+}

administrator/modules/mod_feed/src/Dispatcher/Dispatcher.php

@@ -12,6 +12,7 @@
 
 use Joomla\CMS\Feed\FeedFactory;
 use Joomla\CMS\Language\Text;
+use Joomla\Registry\Registry;
 
 // phpcs:disable PSR1.Files.SideEffects
 \defined('_JEXEC') or die;
@@ -28,19 +29,19 @@ class FeedHelper
      * Method to load a feed.
      *
      * @param   \Joomla\Registry\Registry  $params  The parameters object.
+     * @param   \Joomla\CMS\Feed\FeedFactory  FeedFactory object
      *
-     * @return  \Joomla\CMS\Feed\Feed|string  Return a JFeedReader object or a string message if error.
+     * @return  \Joomla\CMS\Feed\Feed|string  Return a Feed object or a string message if error.
      *
-     * @since   1.5
+     * @since   __DEPLOY_VERSION__
      */
-    public static function getFeed($params)
+    public function getFeedData(Registry $params, FeedFactory $feed): \Joomla\CMS\Feed\Feed|string
     {
         // Module params
         $rssurl = $params->get('rssurl', '');
 
         // Get RSS parsed object
         try {
-            $feed   = new FeedFactory();
             $rssDoc = $feed->getFeed($rssurl);
         } catch (\Exception $e) {
             return Text::_('MOD_FEED_ERR_FEED_NOT_RETRIEVED');
@@ -52,4 +53,24 @@ public static function getFeed($params)
 
         return $rssDoc;
     }
+
+    /**
+     * Method to load a feed.
+     *
+     * @param   \Joomla\Registry\Registry  $params  The parameters object.
+     *
+     * @return  \Joomla\CMS\Feed\Feed|string  Return a Feed object or a string message if error.
+     *
+     * @since   1.5
+     *
+     * @deprecated __DEPLOY_VERSION__ will be removed in 7.0
+     *             Use the non-static method getFeedData
+     *             Example: Factory::getApplication()->bootModule('mod_feed', 'administrator')
+     *                          ->getHelper('FeedHelper')
+     *                          ->getFeedData($params, new FeedFactory())
+     */
+    public static function getFeed($params)
+    {
+        return (new self())->getFeedData($params, new FeedFactory());
+    }
 }