3 * A resolver for resolving controllers locally
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
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 prefix to "Web"
45 $this->setControllerPrefix("Web");
49 * Creates an instance of a resolver class with a given command
51 * @param $controllerName The controller we shall resolve
52 * @param $appInstance 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
57 public final static function createWebControllerResolver ($controllerName, ManageableApplication $appInstance) {
58 // Create the new instance
59 $resolverInstance = new WebControllerResolver();
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);
70 // Set the application instance
71 $resolverInstance->setApplicationInstance($appInstance);
74 $resolverInstance->setControllerName($controllerName);
76 // Return the prepared instance
77 return $resolverInstance;
81 * Resolves the default controller of the given command
83 * @return $controllerInstance A controller instance for the default
85 * @throws InvalidControllerInstanceException Thrown if $controllerInstance
88 public function resolveController () {
91 $controllerInstance = null;
93 // Get the command name
94 $controllerName = $this->getControllerName();
97 $controllerInstance = $this->loadController($controllerName);
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);
105 // Set last controller
106 $this->lastControllerInstance = $controllerInstance;
108 // Return the maybe resolved instance
109 return $controllerInstance;
113 * "Loads" a given controller and instances it if not yet cached. If the
114 * controller was not found one of the default controllers will be used
115 * depending on wether news shall be displayed.
117 * @param $controllerName A controller name we shall look for
118 * @return $controllerInstance A loaded controller instance
119 * @throws InvalidControllerException Thrown if even the requested
120 * controller class is missing (bad!)
122 private function loadController ($controllerName) {
123 // Cache default command
124 $defaultController = $this->getConfigInstance()->readConfig('default_web_command');
126 // Init controller instance
127 $controllerInstance = null;
129 // Default controller
130 $this->setClassName('WebDefaultNewsController');
132 // Generate the class name
133 //* DEBUG: */ echo __METHOD__.": Controller=".$controllerName;
134 if ($controllerName != $defaultController) {
135 // Create controller class name
136 $className = 'Web' . $this->convertToClassName($controllerName) . 'Controller';
139 $this->setClassName($className);
141 // No news at home page or non-news page
142 $this->setClassName('WebDefaultNewsController');
144 //* DEBUG: */ echo ", controller=".$this->getClassName()."<br />\n";
146 // Is this class loaded?
147 if (!class_exists($this->getClassName())) {
148 // Throw an exception here
149 throw new InvalidControllerException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
152 // Set default resolver config name
153 $resolverConfigEntry = '';
155 // Try to read a config entry for our resolver including controller name... ;-)
157 // Create the resolver name
158 $resolverConfigEntry = sprintf("web_cmd_%s_resolver_class", strtolower($controllerName));
160 // Get the config, this will throw an exception if there is no special command resolver
161 $resolverClass = $this->getConfigInstance()->readConfig($resolverConfigEntry);
162 } catch (ConfigEntryNotFoundException $e) {
163 // Use default resolver entry
164 // @TODO Maybe we need to log this?
165 $resolverConfigEntry = 'web_cmd_resolver_class';
168 // Initiate the resolver and controller
169 $resolverInstance = ObjectFactory::createObjectByConfiguredName(
170 $resolverConfigEntry,
173 $this->getApplicationInstance()
176 $controllerInstance = ObjectFactory::createObjectByName(
177 $this->getClassName(),
178 array($resolverInstance)
182 return $controllerInstance;