3 * A resolver for resolving controllers locally
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class WebControllerResolver extends BaseControllerResolver implements ControllerResolver {
26 * Last successfull resolved controller (name)
28 private $lastControllerName = "";
31 * Last successfull resolved controller (instance)
33 private $lastControllerInstance = null;
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
44 // Set part description
45 $this->setObjectDescription("Resolver for local web controllers");
47 // Create unique ID number
48 $this->generateUniqueId();
50 // Set prefix to "Web"
51 $this->setControllerPrefix("Web");
55 * Creates an instance of a resolver class with a given command
57 * @param $controllerName The controller we shall resolve
58 * @param $appInstance An instance of a manageable application helper class
59 * @return $resolverInstance The prepared controller resolver instance
60 * @throws EmptyVariableException Thrown if the default command is not set
61 * @throws InvalidControllerException Thrown if the default controller is invalid
63 public final static function createWebControllerResolver ($controllerName, ManageableApplication $appInstance) {
64 // Create the new instance
65 $resolverInstance = new WebControllerResolver();
67 // Is the variable $controllerName set and the command is valid?
68 if (empty($controllerName)) {
69 // Then thrown an exception here
70 throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
71 } elseif (!$resolverInstance->isControllerValid($controllerName)) {
72 // Invalid command found
73 throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
76 // Set the application instance
77 $resolverInstance->setApplicationInstance($appInstance);
80 $resolverInstance->setControllerName($controllerName);
82 // Return the prepared instance
83 return $resolverInstance;
87 * Resolves the default controller of the given command
89 * @return $controllerInstance A controller instance for the default
91 * @throws InvalidControllerInstanceException Thrown if $controllerInstance
94 public function resolveController () {
97 $controllerInstance = null;
99 // Get the command name
100 $controllerName = $this->getControllerName();
103 $controllerInstance = $this->loadController($controllerName);
106 if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) {
107 // This command has an invalid instance!
108 throw new InvalidControllerInstanceException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
111 // Set last controller
112 $this->lastControllerInstance = $controllerInstance;
114 // Return the maybe resolved instance
115 return $controllerInstance;
119 * "Loads" a given controller and instances it if not yet cached. If the
120 * controller was not found one of the default controllers will be used
121 * depending on wether news shall be displayed.
123 * @param $controllerName A controller name we shall look for
124 * @return $controllerInstance A loaded controller instance
125 * @throws InvalidControllerException Thrown if even the requested
126 * controller class is missing (bad!)
128 private function loadController ($controllerName) {
130 //* DEBUG: */ $this->debugBackTrace();
132 // Cache default command
133 $defaultController = $this->getConfigInstance()->readConfig('default_web_command');
135 // Init controller instance
136 $controllerInstance = null;
138 // Default controller
139 $this->setClassName('WebDefaultController');
141 // Generate the class name
142 //* DEBUG: */ echo __METHOD__.": Controller=".$controllerName;
143 if ($controllerName != $defaultController) {
144 // Create controller class name
145 $this->setClassName(sprintf("Web%sController",
146 $this->convertToClassName($controllerName)
148 } elseif ($this->getConfigInstance()->readConfig('page_with_news') == $this->getApplicationInstance()->getRequestInstance()->getRequestElement('page')) {
149 // Yes, display news in home then set default controller with news
150 $this->setClassName('WebDefaultNewsController');
152 // No news at home page or non-news page
153 $this->setClassName('WebDefaultController');
155 //* DEBUG: */ echo ", controller=".$this->getClassName()."<br />\n";
157 // Is this class loaded?
158 if (!class_exists($this->getClassName())) {
159 // Throw an exception here
160 throw new InvalidControllerException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
163 // Initiate the resolver and controller
164 $resolverInstance = ObjectFactory::createObjectByConfiguredName('web_cmd_resolver_class', array($controllerName, $this->getApplicationInstance()));
165 $controllerInstance = ObjectFactory::createObjectByName($this->getClassName(), array($resolverInstance));
168 unset($resolverInstance);
171 return $controllerInstance;