inc/main/interfaces/resolver/commands/class_CommandResolver.php

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