introducing Entity interfaces and a File one as first implementation

also adds admin settings that pass entities as initial state

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

1 files changed, 84 insertions, 0 deletions

diff --git a/lib/public/WorkflowEngine/IEntity.php b/lib/public/WorkflowEngine/IEntity.php
new file mode 100644
index 00000000000..2e77b741367
--- /dev/null
+++ b/lib/public/WorkflowEngine/IEntity.php
@@ -0,0 +1,84 @@
+<?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 OCP\WorkflowEngine;
+
+/**
+ * Interface IEntity
+ *
+ * This interface represents an entity that supports events the workflow engine
+ * can listen to. For example a file with the create, update, etc. events.
+ *
+ * Ensure to listen to 'OCP/WorkflowEngine::loadEntities' for registering your
+ * entities.
+ *
+ * @package OCP\WorkflowEngine
+ * @since 18.0.0
+ */
+interface IEntity {
+
+	/**
+	 * returns a unique ID of the entity. 
+	 * 
+	 * It can be, but does not need to be the class name of the entitiy. Beware
+	 * that it will be referenced in the database when rules are established,
+	 * so it should not change over the course of the app life.
+	 *
+	 * Example 1: "OCA/MyApp/Entity/Cat"
+	 * Example 2: "myapp_Cats"
+	 * 
+	 * @since 18.0.0
+	 */
+	public function getId(): string;
+	
+	/**
+	 * returns a translated name to be presented in the web interface.
+	 *
+	 * Example: "File" (en), "Dosiero" (eo)
+	 *
+	 * @since 18.0.0
+	 */
+	public function getName(): string;
+
+	/**
+	 * returns the URL to the icon of the entity for display in the web interface.
+	 *
+	 * Usually, the implementation would utilize the `imagePath()` method of the
+	 * `\OCP\IURLGenerator` instance and simply return its result.
+	 *
+	 * Example implementation: return $this->urlGenerator->imagePath('myApp', 'cat.svg');
+	 *
+	 * @since 18.0.0
+	 */
+	public function getIcon(): string;
+
+	/**
+	 * returns a list of supported events
+	 *
+	 * @return IEntityEvent[]
+	 * @since 18.0.0
+	 */
+	public function getEvents(): array;
+
+}