[4.2] Convert the checkfiles plugin to service provider

plugins/task/checkfiles/checkfiles.xml

@@ -9,9 +9,10 @@
 	<authorUrl>www.joomla.org</authorUrl>
 	<version>4.1</version>
 	<description>PLG_TASK_CHECK_FILES_XML_DESCRIPTION</description>
+	<namespace path="src">Joomla\Plugin\Task\Checkfiles</namespace>
 	<files>
-		<filename plugin="checkfiles">checkfiles.php</filename>
-		<folder>language</folder>
+		<folder plugin="checkfiles">services</folder>
+		<folder>src</folder>
 		<folder>forms</folder>
 	</files>
 	<languages>

plugins/task/checkfiles/services/provider.php

@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * @package     Joomla.Plugin
+ * @subpackage  Task.CheckFiles
+ *
+ * @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\PluginInterface;
+use Joomla\CMS\Factory;
+use Joomla\CMS\Plugin\PluginHelper;
+use Joomla\DI\Container;
+use Joomla\DI\ServiceProviderInterface;
+use Joomla\Event\DispatcherInterface;
+use Joomla\Plugin\Task\Checkfiles\Extension\Checkfiles;
+
+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->set(
+            PluginInterface::class,
+            function (Container $container) {
+                $plugin = new Checkfiles(
+                    $container->get(DispatcherInterface::class),
+                    (array) PluginHelper::getPlugin('task', 'checkfiles'),
+                    JPATH_ROOT . '/images/'
+                );
+                $plugin->setApplication(Factory::getApplication());
+
+                return $plugin;
+            }
+        );
+    }
+};

plugins/task/checkfiles/checkfiles.php → plugins/task/checkfiles/src/Extension/Checkfiles.php

@@ -6,27 +6,28 @@
  *
  * @copyright   (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
  * @license     GNU General Public License version 2 or later; see LICENSE.txt
-
- * @phpcs:disable PSR1.Classes.ClassDeclaration.MissingNamespace
  */
 
-use Joomla\CMS\Filesystem\Folder;
+namespace Joomla\Plugin\Task\Checkfiles\Extension;
+
 use Joomla\CMS\Image\Image;
-use Joomla\CMS\Language\Text;
 use Joomla\CMS\Plugin\CMSPlugin;
 use Joomla\Component\Scheduler\Administrator\Event\ExecuteTaskEvent;
 use Joomla\Component\Scheduler\Administrator\Task\Status as TaskStatus;
 use Joomla\Component\Scheduler\Administrator\Traits\TaskPluginTrait;
+use Joomla\Event\DispatcherInterface;
 use Joomla\Event\SubscriberInterface;
+use Joomla\Filesystem\Folder;
 use Joomla\Filesystem\Path;
+use LogicException;
 
 /**
  * Task plugin with routines that offer checks on files.
  * At the moment, offers a single routine to check and resize image files in a directory.
  *
  * @since  4.1.0
  */
-class PlgTaskCheckfiles extends CMSPlugin implements SubscriberInterface
+final class Checkfiles extends CMSPlugin implements SubscriberInterface
 {
     use TaskPluginTrait;
 
@@ -43,12 +44,6 @@ class PlgTaskCheckfiles extends CMSPlugin implements SubscriberInterface
         ],
     ];
 
-    /**
-     * @var boolean
-     * @since 4.1.0
-     */
-    protected $autoloadLanguage = true;
-
     /**
      * @inheritDoc
      *
@@ -65,6 +60,36 @@ public static function getSubscribedEvents(): array
         ];
     }
 
+    /**
+     * @var boolean
+     * @since 4.1.0
+     */
+    protected $autoloadLanguage = true;
+
+    /**
+     * The root directory path
+     *
+     * @var    string
+     * @since  __DEPLOY_VERSION__
+     */
+    private $rootDirectory;
+
+    /**
+     * Constructor.
+     *
+     * @param   DispatcherInterface  $dispatcher     The dispatcher
+     * @param   array                $config         An optional associative array of configuration settings
+     * @param   string               $rootDirectory  The root directory to look for images
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function __construct(DispatcherInterface $dispatcher, array $config, string $rootDirectory)
+    {
+        parent::__construct($dispatcher, $config);
+
+        $this->rootDirectory = $rootDirectory;
+    }
+
     /**
      * @param   ExecuteTaskEvent  $event  The onExecuteTask event
      *
@@ -76,22 +101,19 @@ public static function getSubscribedEvents(): array
      */
     protected function checkImages(ExecuteTaskEvent $event): int
     {
-        $params = $event->getArgument('params');
-
-        $path      = Path::check(JPATH_ROOT . '/images/' . $params->path);
+        $params    = $event->getArgument('params');
+        $path      = Path::check($this->rootDirectory . $params->path);
         $dimension = $params->dimension;
         $limit     = $params->limit;
         $numImages = max(1, (int) $params->numImages ?? 1);
 
-        if (!Folder::exists($path)) {
-            $this->logTask(Text::_('PLG_TASK_CHECK_FILES_LOG_IMAGE_PATH_NA'), 'warning');
+        if (!is_dir($path)) {
+            $this->logTask($this->getApplication()->getLanguage()->_('PLG_TASK_CHECK_FILES_LOG_IMAGE_PATH_NA'), 'warning');
 
             return TaskStatus::NO_RUN;
         }
 
-        $images = Folder::files($path, '^.*\.(jpg|jpeg|png|gif|webp)', 2, true);
-
-        foreach ($images as $imageFilename) {
+        foreach (Folder::files($path, '^.*\.(jpg|jpeg|png|gif|webp)', 2, true) as $imageFilename) {
             $properties = Image::getImageFileProperties($imageFilename);
             $resize     = $properties->$dimension > $limit;
 
@@ -105,23 +127,29 @@ protected function checkImages(ExecuteTaskEvent $event): int
             $newHeight = $dimension === 'height' ? $limit : $height * $limit / $width;
             $newWidth  = $dimension === 'width' ? $limit : $width * $limit / $height;
 
-            $this->logTask(Text::sprintf('PLG_TASK_CHECK_FILES_LOG_RESIZING_IMAGE', $width, $height, $newWidth, $newHeight, $imageFilename));
+            $this->logTask(sprintf(
+                $this->getApplication()->getLanguage()->_('PLG_TASK_CHECK_FILES_LOG_RESIZING_IMAGE'),
+                $width,
+                $height,
+                $newWidth,
+                $newHeight,
+                $imageFilename
+            ));
 
             $image = new Image($imageFilename);
 
             try {
                 $image->resize($newWidth, $newHeight, false);
             } catch (LogicException $e) {
-                $this->logTask('PLG_TASK_CHECK_FILES_LOG_RESIZE_FAIL', 'error');
-                $resizeFail = true;
-            }
+                $this->logTask($this->getApplication()->getLanguage()->_('PLG_TASK_CHECK_FILES_LOG_RESIZE_FAIL'), 'error');
 
-            if (!empty($resizeFail)) {
                 return TaskStatus::KNOCKOUT;
             }
 
             if (!$image->toFile($imageFilename, $properties->type)) {
-                $this->logTask('PLG_TASK_CHECK_FILES_LOG_IMAGE_SAVE_FAIL', 'error');
+                $this->logTask($this->getApplication()->getLanguage()->_('PLG_TASK_CHECK_FILES_LOG_IMAGE_SAVE_FAIL'), 'error');
+
+                return TaskStatus::KNOCKOUT;
             }
 
             --$numImages;