introduce GenericEntityEvent and adapt File entity

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

7 files changed, 39 insertions, 68 deletions

diff --git a/apps/workflowengine/composer/composer/autoload_classmap.php b/apps/workflowengine/composer/composer/autoload_classmap.php
index d0331ea4d4e..4dab03642dd 100644
--- a/apps/workflowengine/composer/composer/autoload_classmap.php
+++ b/apps/workflowengine/composer/composer/autoload_classmap.php
@@ -23,8 +23,6 @@ return array(
     'OCA\\WorkflowEngine\\Controller\\RequestTime' => $baseDir . '/../lib/Controller/RequestTime.php',
     'OCA\\WorkflowEngine\\Controller\\UserWorkflowsController' => $baseDir . '/../lib/Controller/UserWorkflowsController.php',
     'OCA\\WorkflowEngine\\Entity\\File' => $baseDir . '/../lib/Entity/File.php',
-    'OCA\\WorkflowEngine\\Entity\\GenericEntityEmitterEvent' => $baseDir . '/../lib/Entity/GenericEntityEmitterEvent.php',
-    'OCA\\WorkflowEngine\\Entity\\IEntityEmitterEvent' => $baseDir . '/../lib/Entity/IEntityEmitterEvent.php',
     'OCA\\WorkflowEngine\\Helper\\ScopeContext' => $baseDir . '/../lib/Helper/ScopeContext.php',
     'OCA\\WorkflowEngine\\Manager' => $baseDir . '/../lib/Manager.php',
     'OCA\\WorkflowEngine\\Migration\\PopulateNewlyIntroducedDatabaseFields' => $baseDir . '/../lib/Migration/PopulateNewlyIntroducedDatabaseFields.php',
diff --git a/apps/workflowengine/composer/composer/autoload_static.php b/apps/workflowengine/composer/composer/autoload_static.php
index 156f49a69ac..38b1a5b0e76 100644
--- a/apps/workflowengine/composer/composer/autoload_static.php
+++ b/apps/workflowengine/composer/composer/autoload_static.php
@@ -38,8 +38,6 @@ class ComposerStaticInitWorkflowEngine
         'OCA\\WorkflowEngine\\Controller\\RequestTime' => __DIR__ . '/..' . '/../lib/Controller/RequestTime.php',
         'OCA\\WorkflowEngine\\Controller\\UserWorkflowsController' => __DIR__ . '/..' . '/../lib/Controller/UserWorkflowsController.php',
         'OCA\\WorkflowEngine\\Entity\\File' => __DIR__ . '/..' . '/../lib/Entity/File.php',
-        'OCA\\WorkflowEngine\\Entity\\GenericEntityEmitterEvent' => __DIR__ . '/..' . '/../lib/Entity/GenericEntityEmitterEvent.php',
-        'OCA\\WorkflowEngine\\Entity\\IEntityEmitterEvent' => __DIR__ . '/..' . '/../lib/Entity/IEntityEmitterEvent.php',
         'OCA\\WorkflowEngine\\Helper\\ScopeContext' => __DIR__ . '/..' . '/../lib/Helper/ScopeContext.php',
         'OCA\\WorkflowEngine\\Manager' => __DIR__ . '/..' . '/../lib/Manager.php',
         'OCA\\WorkflowEngine\\Migration\\PopulateNewlyIntroducedDatabaseFields' => __DIR__ . '/..' . '/../lib/Migration/PopulateNewlyIntroducedDatabaseFields.php',
diff --git a/apps/workflowengine/lib/Entity/File.php b/apps/workflowengine/lib/Entity/File.php
index d4f41625e4e..b420217c4b6 100644
--- a/apps/workflowengine/lib/Entity/File.php
+++ b/apps/workflowengine/lib/Entity/File.php
@@ -24,9 +24,9 @@ declare(strict_types=1);
 
 namespace OCA\WorkflowEngine\Entity;
 
-use OCP\Files\IRootFolder;
 use OCP\IL10N;
 use OCP\IURLGenerator;
+use OCP\WorkflowEngine\GenericEntityEvent;
 use OCP\WorkflowEngine\IEntity;
 
 class File implements IEntity {
@@ -50,15 +50,14 @@ class File implements IEntity {
 	}
 
 	public function getEvents(): array {
-		$emitterClass = IRootFolder::class;
-		$slot = '\OC\Files';
+		$namespace = '\OCP\Files::';
 		return [
-			new GenericEntityEmitterEvent($emitterClass, $slot, 'postCreate', $this->l10n->t('File created')),
-			new GenericEntityEmitterEvent($emitterClass, $slot, 'postWrite', $this->l10n->t('File updated')),
-			new GenericEntityEmitterEvent($emitterClass, $slot, 'postRename', $this->l10n->t('File renamed')),
-			new GenericEntityEmitterEvent($emitterClass, $slot, 'postDelete', $this->l10n->t('File deleted')),
-			new GenericEntityEmitterEvent($emitterClass, $slot, 'postTouch', $this->l10n->t('File accessed')),
-			new GenericEntityEmitterEvent($emitterClass, $slot, 'postCopy', $this->l10n->t('File copied')),
+			new GenericEntityEvent($this->l10n->t('File created'), $namespace . 'postCreate' ),
+			new GenericEntityEvent($this->l10n->t('File updated'), $namespace . 'postWrite' ),
+			new GenericEntityEvent($this->l10n->t('File renamed'), $namespace . 'postRename' ),
+			new GenericEntityEvent($this->l10n->t('File deleted'), $namespace . 'postDelete' ),
+			new GenericEntityEvent($this->l10n->t('File accessed'), $namespace . 'postTouch' ),
+			new GenericEntityEvent($this->l10n->t('File copied'), $namespace . 'postCopy' ),
 		];
 	}
 }
diff --git a/apps/workflowengine/lib/Entity/IEntityEmitterEvent.php b/apps/workflowengine/lib/Entity/IEntityEmitterEvent.php
deleted file mode 100644
index 7e2c802fe76..00000000000
--- a/apps/workflowengine/lib/Entity/IEntityEmitterEvent.php
+++ /dev/null
@@ -1,34 +0,0 @@
-<?php
-declare(strict_types=1);
-/**
- * @copyright Copyright (c) 2019 Arthur Schiwon <blizzz@arthur-schiwon.de>
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- */
-
-namespace OCA\WorkflowEngine\Entity;
-
-
-use OCP\WorkflowEngine\IEntityEvent;
-
-interface IEntityEmitterEvent extends IEntityEvent {
-	public function getEmitterClassName(): string;
-
-	public function getSlot(): string;
-}
diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index f8fb8b76d6b..6673cbe70a7 100644
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -438,6 +438,7 @@ return array(
     'OCP\\User\\Backend\\ISetDisplayNameBackend' => $baseDir . '/lib/public/User/Backend/ISetDisplayNameBackend.php',
     'OCP\\User\\Backend\\ISetPasswordBackend' => $baseDir . '/lib/public/User/Backend/ISetPasswordBackend.php',
     'OCP\\Util' => $baseDir . '/lib/public/Util.php',
+    'OCP\\WorkflowEngine\\GenericEntityEvent' => $baseDir . '/lib/public/WorkflowEngine/GenericEntityEvent.php',
     'OCP\\WorkflowEngine\\ICheck' => $baseDir . '/lib/public/WorkflowEngine/ICheck.php',
     'OCP\\WorkflowEngine\\IComplexOperation' => $baseDir . '/lib/public/WorkflowEngine/IComplexOperation.php',
     'OCP\\WorkflowEngine\\IEntity' => $baseDir . '/lib/public/WorkflowEngine/IEntity.php',
diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index ab47f44ff8e..d4b74d5c231 100644
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -472,6 +472,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
         'OCP\\User\\Backend\\ISetDisplayNameBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/ISetDisplayNameBackend.php',
         'OCP\\User\\Backend\\ISetPasswordBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/ISetPasswordBackend.php',
         'OCP\\Util' => __DIR__ . '/../../..' . '/lib/public/Util.php',
+        'OCP\\WorkflowEngine\\GenericEntityEvent' => __DIR__ . '/../../..' . '/lib/public/WorkflowEngine/GenericEntityEvent.php',
         'OCP\\WorkflowEngine\\ICheck' => __DIR__ . '/../../..' . '/lib/public/WorkflowEngine/ICheck.php',
         'OCP\\WorkflowEngine\\IComplexOperation' => __DIR__ . '/../../..' . '/lib/public/WorkflowEngine/IComplexOperation.php',
         'OCP\\WorkflowEngine\\IEntity' => __DIR__ . '/../../..' . '/lib/public/WorkflowEngine/IEntity.php',
diff --git a/apps/workflowengine/lib/Entity/GenericEntityEmitterEvent.php b/lib/public/WorkflowEngine/GenericEntityEvent.php
index 60b238432c9..d72093573bf 100644
--- a/apps/workflowengine/lib/Entity/GenericEntityEmitterEvent.php
+++ b/lib/public/WorkflowEngine/GenericEntityEvent.php
@@ -22,38 +22,46 @@ declare(strict_types=1);
  *
  */
 
-namespace OCA\WorkflowEngine\Entity;
+namespace OCP\WorkflowEngine;
+
+class GenericEntityEvent implements IEntityEvent {
 
-class GenericEntityEmitterEvent implements IEntityEmitterEvent {
-	/** @var string */
-	private $emitterClassName;
-	/** @var string */
-	private $eventName;
 	/** @var string */
 	private $displayName;
 	/** @var string */
-	private $slot;
-
-	public function __construct(string $emitterClassName, string $slot, string $eventName, string $displayName) {
-		$this->emitterClassName = $emitterClassName;
-		$this->eventName = $eventName;
-		$this->displayName = $displayName;
-		$this->slot = $slot;
-	}
+	private $eventName;
 
-	public function getEmitterClassName(): string {
-		return $this->emitterClassName;
-	}
+	public function __construct(string $displayName, string $eventName) {
+		if(trim($displayName) === '') {
+			throw new \InvalidArgumentException('DisplayName must not be empty');
+		}
+		if(trim($eventName) === '') {
+			throw new \InvalidArgumentException('EventName must not be empty');
+		}
 
-	public function getSlot(): string {
-		return $this->slot;
+		$this->displayName = trim($displayName);
+		$this->eventName = trim($eventName);
 	}
 
+	/**
+	 * returns a translated name to be presented in the web interface.
+	 *
+	 * Example: "created" (en), "kreita" (eo)
+	 *
+	 * @since 18.0.0
+	 */
 	public function getDisplayName(): string {
-		return $this->displayName;
+		return $this->getDisplayName();
 	}
 
+	/**
+	 * returns the event name that is emitted by the EventDispatcher, e.g.:
+	 *
+	 * Example: "OCA\MyApp\Factory\Cats::postCreated"
+	 *
+	 * @since 18.0.0
+	 */
 	public function getEventName(): string {
-		return $this->eventName;
+		return $this->getEventName();
 	}
 }