core: Implement action factory (#1002)

1 files changed, 34 insertions, 0 deletions

diff --git a/lib/ActionInterface.php b/lib/ActionInterface.php
new file mode 100644
index 00000000..c38d057a
--- /dev/null
+++ b/lib/ActionInterface.php
@@ -0,0 +1,34 @@
+<?php
+/**
+ * This file is part of RSS-Bridge, a PHP project capable of generating RSS and
+ * Atom feeds for websites that don't have one.
+ *
+ * For the full license information, please view the UNLICENSE file distributed
+ * with this source code.
+ *
+ * @package	Core
+ * @license	http://unlicense.org/ UNLICENSE
+ * @link	https://github.com/rss-bridge/rss-bridge
+ */
+
+/**
+ * Interface for action objects.
+ */
+interface ActionInterface {
+	/**
+	 * Set user data for the action to consume.
+	 *
+	 * @param array $userData An associative array of user data.
+	 * @return void
+	 */
+	function setUserData($userData);
+
+	/**
+	 * Execute the action.
+	 *
+	 * Note: This function directly outputs data to the user.
+	 *
+	 * @return void
+	 */
+	function execute();
+}