application/shipsimu/main/resolver/controller/html/class_ShipSimuHtmlControllerResolver.php

   1 <?php
   2 /**
   3  * A resolver for resolving controllers locally
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 ShipSimuHtmlControllerResolver extends BaseControllerResolver implements ControllerResolver {
  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 'ShipSimuHtml'
  35                 $this->setClassPrefix('ShipSimuHtml');
  36         }
  37
  38         /**
  39          * Creates an instance of a resolver class with a given command
  40          *
  41          * @param       $controllerName                         The controller we shall resolve
  42          * @param       $applicationInstance            An instance of a manageable application helper class
  43          * @return      $resolverInstance                       The prepared controller resolver instance
  44          * @throws      EmptyVariableException          Thrown if default command is not set
  45          * @throws      InvalidControllerException      Thrown if default controller is invalid
  46          */
  47         public static final function createShipSimuHtmlControllerResolver ($controllerName, ManageableApplication $applicationInstance) {
  48                 // Create the new instance
  49                 $resolverInstance = new ShipSimuHtmlControllerResolver();
  50
  51                 // Is the variable $controllerName set and the command is valid?
  52                 if (empty($controllerName)) {
  53                         // Then thrown an exception here
  54                         throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  55                 } elseif ($resolverInstance->isControllerValid($controllerName) === FALSE) {
  56                         // Invalid command found
  57                         throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
  58                 }
  59
  60                 // Set the application instance
  61                 $resolverInstance->setApplicationInstance($applicationInstance);
  62
  63                 // Set command name
  64                 $resolverInstance->setControllerName($controllerName);
  65
  66                 // Return the prepared instance
  67                 return $resolverInstance;
  68         }
  69
  70         /**
  71          * Resolves the default controller of the given command
  72          *
  73          * @return      $controllerInstance             A controller instance for the default
  74          *                                                                      command
  75          * @throws      InvalidControllerInstanceException      Thrown if $controllerInstance
  76          *                                                                                              is invalid
  77          */
  78         public function resolveController () {
  79                 // Init variables
  80                 $controllerName = '';
  81                 $controllerInstance = NULL;
  82
  83                 // Get the command name
  84                 $controllerName = $this->getControllerName();
  85
  86                 // Get the command
  87                 $controllerInstance = $this->loadController($controllerName);
  88
  89                 // And validate it
  90                 if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) {
  91                         // This command has an invalid instance!
  92                         throw new InvalidControllerInstanceException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
  93                 } // END - if
  94
  95                 // Set last controller
  96                 $this->setResolvedInstance($controllerInstance);
  97
  98                 // Return the maybe resolved instance
  99                 return $controllerInstance;
 100         }
 101 }
 102
 103 // [EOF]
 104 ?>