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