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

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