inc/classes/main/resolver/web/class_WebControllerResolver.php

   1 <?php
   2 /**
   3  * A resolver for resolving controllers locally
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 WebControllerResolver extends BaseResolver implements ControllerResolver {
  25         /**
  26          * Last successfull resolved controller (name)
  27          */
  28         private $lastControllerName = "";
  29
  30         /**
  31          * Last successfull resolved controller (instance)
  32          */
  33         private $lastControllerInstance = null;
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43
  44                 // Set part description
  45                 $this->setObjectDescription("Resolver for local web controllers");
  46
  47                 // Create unique ID number
  48                 $this->generateUniqueId();
  49
  50                 // Set prefix to "Web"
  51                 $this->setCommandPrefix("Web");
  52         }
  53
  54         /**
  55          * Creates an instance of a resolver class with a given command
  56          *
  57          * @param       $commandName                            The default command we shall execute
  58          * @param       $appInstance                            An instance of a manageable application helper class
  59          * @return      $resolverInstance                       The prepared command resolver instance
  60          * @throws      EmptyVariableException          Thrown if the default command is not set
  61          * @throws      InvalidCommandException         Thrown if the default command is invalid
  62          */
  63         public final static function createWebControllerResolver ($commandName, ManageableApplication $appInstance) {
  64                 // Create the new instance
  65                 $resolverInstance = new WebControllerResolver();
  66
  67                 // Is the variable $commandName set and the command is valid?
  68                 if (empty($commandName)) {
  69                         // Then thrown an exception here
  70                         throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  71                 } elseif (!$resolverInstance->isCommandValid($commandName)) {
  72                         // Invalid command found
  73                         throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
  74                 }
  75
  76                 // Set the application instance
  77                 $resolverInstance->setApplicationInstance($appInstance);
  78
  79                 // Return the prepared instance
  80                 return $resolverInstance;
  81         }
  82
  83         /**
  84          * Resolves the default controller of the given command
  85          *
  86          * @return      $controllerInstance             A controller instance for the default
  87          *                                                                      command
  88          * @throws      InvalidCommandException                         Thrown if $commandName is
  89          *                                                                                              invalid
  90          * @throws      InvalidControllerInstanceException      Thrown if $commandInstance
  91          *                                                                                              is invalid
  92          */
  93         public function resolveCommandController () {
  94                 // Init variables
  95                 $commandName = "";
  96                 $controllerInstance = null;
  97
  98                 // Try to resolv the command
  99                 try {
 100                         // Get the command name
 101                         $commandName = $this->getCommandName();
 102
 103                         // Check if the command is valid
 104                         if (!$this->isCommandValid($commandName)) {
 105                                 // This command is invalid!
 106                                 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
 107                         }
 108
 109                         // Get the command
 110                         $controllerInstance = $this->loadController($commandName);
 111
 112                         // And validate it
 113                         if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) {
 114                                 // This command has an invalid instance!
 115                                 throw new InvalidControllerInstanceException(array($this, $commandName), self::EXCEPTION_INVALID_CONTROLLER);
 116                         }
 117
 118                         // Set last controller
 119                         $this->lastControllerInstance = $controllerInstance;
 120                 } catch (MissingArrayElementsException $e) {
 121                         // Just catch it here...
 122                 }
 123
 124                 // Return the maybe resolved instance
 125                 return $controllerInstance;
 126         }
 127
 128         /**
 129          * "Loads" a given controller and instances it if not yet cached. If the
 130          * controller was not found one of the default controllers will be used
 131          * depending on wether news shall be displayed.
 132          *
 133          * @param       $commandName                    A controller name we shall look for
 134          * @return      $controllerInstance             A loaded controller instance
 135          * @throws      DefaultControllerException      Thrown if even the default
 136          *                                                                              controller class is missing (bad!)
 137          */
 138         private function loadController ($commandName) {
 139                  // Debug message
 140                  //print("<strong>----- ".__METHOD__." -----</strong><pre>");
 141                  //debug_print_backtrace();
 142                  //print("</pre>");
 143                  //
 144
 145                 // Cache default command
 146                 $defaultCommand = $this->getConfigInstance()->readConfig('default_command');
 147
 148                 // Init controller instance
 149                 $controllerInstance = null;
 150
 151                 // Default controller
 152                 $class = "WebDefaultController";
 153
 154                 // Generate the class name
 155                 //* DEBUG: */ echo __METHOD__.": Command=".$commandName;
 156                 if ($commandName != $defaultCommand) {
 157                         // Create controller class name
 158                         $class = sprintf("Web%sController",
 159                                 $this->convertToClassName($commandName)
 160                         );
 161                 } elseif ($this->getConfigInstance()->readConfig('home_with_news') == "Y") {
 162                         // Yes, display news in home then set default controller with news
 163                         $class = "WebDefaultNewsController";
 164                 } else {
 165                         // No nes at "home" page
 166                         $class = "WebDefaultController";
 167                 }
 168                 //* DEBUG: */ echo ", controller=".$class."<br />\n";
 169
 170                 // Is this class loaded?
 171                 if (!class_exists($class)) {
 172                         // Class not found, so try the default one or throw exception
 173                         if ($commandName != $defaultCommand) {
 174                                 // Try the default controller
 175                                 return $this->loadController($defaultCommand);
 176                         } else {
 177                                 // Still not found?
 178                                 throw new DefaultControllerException($this, self::EXCEPTION_DEFAUL_CONTROLLER_GONE);
 179                         }
 180                 } // END - if
 181
 182                 // Initiate the resolver and controller
 183                 $resolverInstance = ObjectFactory::createObjectByConfiguredName('web_cmd_resolver_class', array($commandName, $this->getApplicationInstance()));
 184                 $controllerInstance = ObjectFactory::createObjectByName($class, array($resolverInstance));
 185
 186                 // Remove resolver
 187                 unset($resolverInstance);
 188
 189                 // Return the result
 190                 return $controllerInstance;
 191         }
 192 }
 193
 194 // [EOF]
 195 ?>