framework/main/classes/resolver/command/image/class_ImageCommandResolver.php

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