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\BaseCommand;
   7 use CoreFramework\Command\InvalidCommandException;
   8 use CoreFramework\Manager\ManageableApplication;
   9
  10 /**
  11  * A command resolver for local (non-hubbed) web commands
  12  *
  13  * @author              Roland Haeder <webmaster@shipsimu.org>
  14  * @version             0.0.0
  15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  16  * @license             GNU GPL 3.0 or any newer version
  17  * @link                http://www.shipsimu.org
  18  *
  19  * This program is free software: you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation, either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  31  */
  32 class ConsoleCommandResolver extends BaseCommandResolver implements CommandResolver {
  33         /**
  34          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         protected function __construct () {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41
  42                 // Set prefix to "Console"
  43                 $this->setClassPrefix('console');
  44         }
  45
  46         /**
  47          * Creates an instance of a Console command resolver with a given default command
  48          *
  49          * @param       $commandName                            The default command we shall execute
  50          * @param       $applicationInstance            An instance of a manageable application helper class
  51          * @return      $resolverInstance                       The prepared command resolver instance
  52          * @throws      EmptyVariableException          Thrown if default command is not set
  53          * @throws      InvalidCommandException         Thrown if default command is invalid
  54          */
  55         public static final function createConsoleCommandResolver ($commandName, ManageableApplication $applicationInstance) {
  56                 // Create the new instance
  57                 $resolverInstance = new ConsoleCommandResolver();
  58
  59                 // Is the variable $commandName set and the command is valid?
  60                 if (empty($commandName)) {
  61                         // Then thrown an exception here
  62                         throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  63                 } elseif ($resolverInstance->isCommandValid($commandName) === FALSE) {
  64                         // Invalid command found
  65                         throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
  66                 }
  67
  68                 // Set the application instance
  69                 $resolverInstance->setApplicationInstance($applicationInstance);
  70
  71                 // Return the prepared instance
  72                 return $resolverInstance;
  73         }
  74
  75 }