3 namespace CoreFramework\Resolver\Action;
5 // Import framework stuff
6 use CoreFramework\Request\Requestable;
9 * An instance for action resolver classes
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 interface ActionResolver extends Resolver {
32 * Returns an action instance for the current action
34 * @return $actionInstance An instance of the resolved action
36 function resolveAction ();
39 * Returns an action instance for a given request class
41 * @param $requestInstance An instance of a Requestable class
42 * @return $actionInstance An instance of the resolved action
44 function resolveActionByRequest (Requestable $requestInstance);
47 * Checks whether the given action is valid
49 * @param $actionName The default action we shall execute
50 * @return $isValid Whether the given action is valid
51 * @throws EmptyVariableException Thrown if given action is not set
53 function isActionValid ($actionName);