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

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