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

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