aboutsummaryrefslogtreecommitdiff
path: root/lib/ActionInterface.php
blob: c38d057a09534846114337495eab37a1a4922a74 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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();
}