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

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