framework/main/interfaces/resolver/actions/class_ActionResolver.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Resolver\Action;
   4
   5 // Import framework stuff
   6 use CoreFramework\Request\Requestable;
   7 use CoreFramework\Resolver\Resolver;
   8
   9 /**
  10  * An instance for action resolver classes
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.org
  17  *
  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.
  22  *
  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.
  27  *
  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/>.
  30  */
  31 interface ActionResolver extends Resolver {
  32         /**
  33          * Returns an action instance for the current action
  34          *
  35          * @return      $actionInstance         An instance of the resolved action
  36          */
  37         function resolveAction ();
  38
  39         /**
  40          * Returns an action instance for a given request class
  41          *
  42          * @param       $requestInstance        An instance of a Requestable class
  43          * @return      $actionInstance         An instance of the resolved action
  44          */
  45         function resolveActionByRequest (Requestable $requestInstance);
  46
  47         /**
  48          * Checks whether the given action is valid
  49          *
  50          * @param       $actionName             The default action we shall execute
  51          * @return      $isValid                Whether the given action is valid
  52          * @throws      EmptyVariableException  Thrown if given action is not set
  53          */
  54         function isActionValid ($actionName);
  55
  56 }