Migrate MaintenanceEventListener to Maintenance Tasks (#328)

Author: blankse

phpstan-baseline.neon

@@ -30,11 +30,6 @@ parameters:
 			count: 1
 			path: src/DuplicatesIndex/DefaultMariaDbDuplicatesIndex.php
 
-		-
-			message: "#^Parameter \\$e of method CustomerManagementFrameworkBundle\\\\Event\\\\MaintenanceEventListener\\:\\:onMaintenance\\(\\) has invalid type Pimcore\\\\Event\\\\System\\\\MaintenanceEvent\\.$#"
-			count: 1
-			path: src/Event/MaintenanceEventListener.php
-
 		-
 			message: "#^Result of && is always false\\.$#"
 			count: 1

src/Event/MaintenanceEventListener.php renamed to src/Maintenance/Tasks/CleanupEmptyFoldersTask.php

@@ -13,13 +13,14 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace CustomerManagementFrameworkBundle\Event;
+namespace CustomerManagementFrameworkBundle\Maintenance\Tasks;
 
-class MaintenanceEventListener
+use Pimcore\Maintenance\TaskInterface;
+
+class CleanupEmptyFoldersTask implements TaskInterface
 {
-    public function onMaintenance(\Pimcore\Event\System\MaintenanceEvent $e)
+    public function execute(): void
     {
-        \Pimcore::getContainer()->get('cmf.customer_exporter_manager')->cleanupExportTmpData();
         \Pimcore::getContainer()->get('cmf.customer_provider.object_naming_scheme')->cleanupEmptyFolders();
     }
 }

src/Maintenance/Tasks/CleanupExportTmpDataTask.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace CustomerManagementFrameworkBundle\Maintenance\Tasks;
+
+use Pimcore\Maintenance\TaskInterface;
+
+class CleanupExportTmpDataTask implements TaskInterface
+{
+    public function execute(): void
+    {
+        \Pimcore::getContainer()->get('cmf.customer_exporter_manager')->cleanupExportTmpData();
+    }
+}

src/Resources/config/services.yml

@@ -124,6 +124,14 @@ services:
                 'cleanUpFilterDefinitions': '@CustomerManagementFrameworkBundle\CustomerView\FilterDefinition\Maintenance'
                 'cleanUpTemporaryCustomers': '@CustomerManagementFrameworkBundle\CustomerView\Customer\Maintenance'
 
+    CustomerManagementFrameworkBundle\Maintenance\Tasks\CleanupEmptyFoldersTask:
+        tags:
+            - { name: pimcore.maintenance.task, type: cmf_cleanup_empty_folders }
+
+    CustomerManagementFrameworkBundle\Maintenance\Tasks\CleanupExportTmpDataTask:
+        tags:
+            - { name: pimcore.maintenance.task, type: cmf_cleanup_export_tmp_data }
+
     cmf.logger:
         alias: monolog.logger.cmf
 

src/Resources/config/services_events.yml

@@ -27,11 +27,6 @@ services:
                - { name: kernel.event_listener, event: plugin.ObjectMerger.postMerge, method: onPostMerge }
                - { name: kernel.event_listener, event: plugin.ObjectMerger.preMerge, method: onPreMerge }
 
-    cmf.event_listener.maintenance:
-          class: CustomerManagementFrameworkBundle\Event\MaintenanceEventListener
-          tags:
-              - { name: kernel.event_listener, event: pimcore.system.maintenance, method: onMaintenance }
-
     CustomerManagementFrameworkBundle\ActionTrigger\EventHandler\EventHandlerInterface:
         alias: cmf.event_listener.action_trigger