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