application/hub/classes/resolver/command/html/class_HubHtmlCommandResolver.php

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