application/shipsimu/main/resolver/web/class_WebCompanyCommandResolver.php

   1 <?php
   2 /**
   3  * A command resolver for local (non-hubbed) web commands including the failed government request
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu 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 WebCompanyCommandResolver extends BaseCommandResolver implements CommandResolver {
  25         /**
  26          * Last successfull resolved command
  27          */
  28         private $lastCommandInstance = null;
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Set prefix to "Web"
  40                 $this->setCommandPrefix('Web');
  41         }
  42
  43         /**
  44          * Creates an instance of a Web command resolver with a given default command
  45          *
  46          * @param       $commandName                            The default command we shall execute
  47          * @param       $appInstance                            An instance of a manageable application helper class
  48          * @return      $resolverInstance                       The prepared command resolver instance
  49          * @throws      EmptyVariableException          Thrown if default command is not set
  50          * @throws      InvalidInterfaceException       Thrown if command does not implement interface Commandable
  51          */
  52         public static final function createWebCompanyCommandResolver ($commandName, ManageableApplication $appInstance) {
  53                 // Create the new instance
  54                 $resolverInstance = new WebCompanyCommandResolver();
  55
  56                 // Get request instance
  57                 $requestInstance = $appInstance->getRequestInstance();
  58
  59                 // Is the variable $commandName set and the command is valid?
  60                 if (empty($commandName)) {
  61                         // Then thrown an exception here
  62                         throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  63                 } elseif (!$resolverInstance->resolveCommandByRequest($requestInstance) instanceof Commandable) {
  64                         // Invalid command found (missing interface?)
  65                         throw new InvalidInterfaceException(array($userInstance, 'ManageableMember'), self::EXCEPTION_REQUIRED_INTERFACE_MISSING);
  66                 }
  67
  68                 // Set the application instance
  69                 $resolverInstance->setApplicationInstance($appInstance);
  70
  71                 // Return the prepared instance
  72                 return $resolverInstance;
  73         }
  74
  75         /**
  76          * Returns an command instance for a given request class or null if
  77          * it was not found
  78          *
  79          * @param       $requestInstance        An instance of a request class
  80          * @return      $commandInstance        An instance of the resolved command
  81          * @throws      InvalidCommandException                         Thrown if $commandName is
  82          *                                                                                              invalid
  83          * @throws      InvalidCommandInstanceException         Thrown if $commandInstance
  84          *                                                                                              is an invalid instance
  85          */
  86         public function resolveCommandByRequest (Requestable $requestInstance) {
  87                 // Init instance
  88                 $commandInstance = null;
  89
  90                 // This goes fine so let's resolv the command
  91                 $commandName = str_replace('-', '_', $requestInstance->getRequestElement('app')) . '_' . $requestInstance->getRequestElement('page');
  92
  93                 // Is there a "failed" request?
  94                 if ($requestInstance->isRequestElementSet('failed')) {
  95                         // Then include with within the command name
  96                         $commandName = $commandName . '_' . $requestInstance->getRequestElement('failed');
  97                 } // END - if
  98
  99                 // Is the command empty? Then fall back to default command
 100                 if (empty($commandName)) $commandName = $this->getConfigInstance()->getConfigEntry('default_web_command');
 101
 102                 // Check if command is valid
 103                 if ($this->isCommandValid($commandName) === false) {
 104                         // This command is invalid!
 105                         throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
 106                 } // END - if
 107
 108                 // Get the command
 109                 $commandInstance = $this->loadCommand($commandName);
 110
 111                 // And validate it
 112                 if ((!is_object($commandInstance)) || (!$commandInstance instanceof Commandable)) {
 113                         // This command has an invalid instance!
 114                         throw new InvalidCommandInstanceException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
 115                 } // END - if
 116
 117                 // Set last command
 118                 $this->lastCommandInstance = $commandInstance;
 119
 120                 // Return the resolved command instance
 121                 return $commandInstance;
 122         }
 123
 124         /**
 125          * Resolves the command by its direct name and returns an instance of its class
 126          *
 127          * @param       $commandName            The direct command name we shall resolve
 128          * @return      $commandInstance        An instance of the command class
 129          * @throws      InvalidCommandException         Thrown if $commandName is invalid
 130          */
 131         public function resolveCommand ($commandName) {
 132                 // Initiate the instance variable
 133                 $commandInstance = null;
 134
 135                 // Is the command empty? Then fall back to default command
 136                 if (empty($commandName)) $commandName = $this->getConfigInstance()->getConfigEntry('default_web_command');
 137
 138                 // Check if command is valid
 139                 if ($this->isCommandValid($commandName) === false) {
 140                         // This command is invalid!
 141                         throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
 142                 }
 143
 144                 // Get the command
 145                 $commandInstance = $this->loadCommand($commandName);
 146
 147                 // Return the instance
 148                 return $commandInstance;
 149         }
 150
 151         /**
 152          * "Loads" a given command and instances it if not yet cached
 153          *
 154          * @param       $commandName                            A command name we shall look for
 155          * @return      $commandInstance                        A loaded command instance
 156          * @throws      InvalidCommandException         Thrown if even the default
 157          *                                                                              command class is missing (bad!)
 158          */
 159         private function loadCommand ($commandName) {
 160                 // Cache default command
 161                 $defaultCommand = $this->getConfigInstance()->getConfigEntry('default_web_command');
 162
 163                 // Init command instance
 164                 $commandInstance = null;
 165
 166                 // Get 'app' from the application
 167                 $app = Registry::getRegistry()->getInstance('application')->getRequestInstance()->getRequestElement('app');
 168
 169                 // Create command class name
 170                 $this->setClassName(sprintf("%s%sCommand",
 171                         $this->getCommandPrefix(),
 172                         $this->convertToClassName($commandName)
 173                 ));
 174
 175                 // Is this class loaded?
 176                 if (!class_exists($this->getClassName())) {
 177                         // Class not found, so throw an exception
 178                         throw new InvalidCommandException(array($this, $defaultCommand), self::EXCEPTION_INVALID_COMMAND);
 179                 } // END - if
 180
 181                 // Initiate the command
 182                 $commandInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
 183
 184                 // Return the result
 185                 return $commandInstance;
 186         }
 187 }
 188
 189 // [EOF]
 190 ?>