inc/main/classes/resolver/command/console/class_ConsoleCommandResolver.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Resolver\Command;
   4
   5 // Import framework stuff
   6 use CoreFramework\Command\InvalidCommandException;
   7 use CoreFramework\Manager\ManageableApplication;
   8
   9 /**
  10  * A command resolver for local (non-hubbed) web commands
  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 class ConsoleCommandResolver extends BaseCommandResolver implements CommandResolver {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40
  41                 // Set prefix to "Console"
  42                 $this->setClassPrefix('console');
  43         }
  44
  45         /**
  46          * Creates an instance of a Console command resolver with a given default command
  47          *
  48          * @param       $commandName                            The default command we shall execute
  49          * @param       $applicationInstance            An instance of a manageable application helper class
  50          * @return      $resolverInstance                       The prepared command resolver instance
  51          * @throws      EmptyVariableException          Thrown if default command is not set
  52          * @throws      InvalidCommandException         Thrown if default command is invalid
  53          */
  54         public static final function createConsoleCommandResolver ($commandName, ManageableApplication $applicationInstance) {
  55                 // Create the new instance
  56                 $resolverInstance = new ConsoleCommandResolver();
  57
  58                 // Is the variable $commandName set and the command is valid?
  59                 if (empty($commandName)) {
  60                         // Then thrown an exception here
  61                         throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  62                 } elseif ($resolverInstance->isCommandValid($commandName) === FALSE) {
  63                         // Invalid command found
  64                         throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
  65                 }
  66
  67                 // Set the application instance
  68                 $resolverInstance->setApplicationInstance($applicationInstance);
  69
  70                 // Return the prepared instance
  71                 return $resolverInstance;
  72         }
  73
  74 }