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