inc/classes/main/resolver/controller/console/class_ConsoleControllerResolver.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, 2009 - 2011 Core Developer Team
   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 ConsoleControllerResolver extends BaseControllerResolver 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 prefix to "Console"
  45                 $this->setClassPrefix('Console');
  46         }
  47
  48         /**
  49          * Creates an instance of a resolver class with a given command
  50          *
  51          * @param       $controllerName                         The controller we shall resolve
  52          * @param       $applicationInstance            An instance of a manageable application helper class
  53          * @return      $resolverInstance                       The prepared controller resolver instance
  54          * @throws      EmptyVariableException          Thrown if default command is not set
  55          * @throws      InvalidControllerException      Thrown if default controller is invalid
  56          */
  57         public static final function createConsoleControllerResolver ($controllerName, ManageableApplication $applicationInstance) {
  58                 // Create the new instance
  59                 $resolverInstance = new ConsoleControllerResolver();
  60
  61                 // Is the variable $controllerName set and the command is valid?
  62                 if (empty($controllerName)) {
  63                         // Then thrown an exception here
  64                         throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  65                 } elseif ($resolverInstance->isControllerValid($controllerName) === false) {
  66                         // Invalid command found
  67                         throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
  68                 }
  69
  70                 // Set the application instance
  71                 $resolverInstance->setApplicationInstance($applicationInstance);
  72
  73                 // Set command name
  74                 $resolverInstance->setControllerName($controllerName);
  75
  76                 // Return the prepared instance
  77                 return $resolverInstance;
  78         }
  79
  80         /**
  81          * Resolves the default controller of the given command
  82          *
  83          * @return      $controllerInstance             A controller instance for the default
  84          *                                                                      command
  85          * @throws      InvalidControllerInstanceException      Thrown if $controllerInstance
  86          *                                                                                              is invalid
  87          */
  88         public function resolveController () {
  89                 // Init variables
  90                 $controllerName = '';
  91                 $controllerInstance = null;
  92
  93                 // Get the command name
  94                 $controllerName = $this->getControllerName();
  95
  96                 // Get the command
  97                 $controllerInstance = $this->loadController($controllerName);
  98
  99                 // And validate it
 100                 if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) {
 101                         // This command has an invalid instance!
 102                         throw new InvalidControllerInstanceException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
 103                 } // END - if
 104
 105                 // Set last controller
 106                 $this->setResolvedInstance($controllerInstance);
 107
 108                 // Return the maybe resolved instance
 109                 return $controllerInstance;
 110         }
 111 }
 112
 113 // [EOF]
 114 ?>