]> git.mxchange.org Git - core.git/blob - inc/classes/interfaces/resolver/actions/class_ActionResolver.php
Copyright year updated, converted double->single quotes
[core.git] / inc / classes / interfaces / resolver / actions / class_ActionResolver.php
1 <?php
2 /**
3  * An instance for action resolver classes
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 interface ActionResolver extends Resolver {
25         /**
26          * Returns an action instance for the current action
27          *
28          * @return      $actionInstance         An instance of the resolved action
29          */
30         function resolveAction ();
31
32         /**
33          * Returns an action instance for a given request class
34          *
35          * @param       $requestInstance        An instance of a request class
36          * @return      $actionInstance         An instance of the resolved action
37          */
38         function resolveActionByRequest (Requestable $requestInstance);
39
40         /**
41          * Checks whether the given action is valid
42          *
43          * @param       $actionName             The default action we shall execute
44          * @return      $isValid                Whether the given action is valid
45          * @throws      EmptyVariableException  Thrown if given action is not set
46          */
47         function isActionValid ($actionName);
48 }
49
50 // [EOF]
51 ?>