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 BaseResolver 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->setCommandPrefix("Web");
55 * Creates an instance of a resolver class with a given command
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
63 public final static function createWebControllerResolver ($commandName, ManageableApplication $appInstance) {
64 // Create the new instance
65 $resolverInstance = new WebControllerResolver();
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);
76 // Set the application instance
77 $resolverInstance->setApplicationInstance($appInstance);
79 // Return the prepared instance
80 return $resolverInstance;
84 * Resolves the default controller of the given command
86 * @return $controllerInstance A controller instance for the default
88 * @throws InvalidCommandException Thrown if $commandName is
90 * @throws InvalidControllerInstanceException Thrown if $commandInstance
93 public function resolveCommandController () {
96 $controllerInstance = null;
98 // Get the command name
99 $commandName = $this->getCommandName();
101 // Check if the command is valid
102 if (!$this->isCommandValid($commandName)) {
103 // This command is invalid!
104 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
108 $controllerInstance = $this->loadController($commandName);
111 if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) {
112 // This command has an invalid instance!
113 throw new InvalidControllerInstanceException(array($this, $commandName), self::EXCEPTION_INVALID_CONTROLLER);
116 // Set last controller
117 $this->lastControllerInstance = $controllerInstance;
119 // Return the maybe resolved instance
120 return $controllerInstance;
124 * "Loads" a given controller and instances it if not yet cached. If the
125 * controller was not found one of the default controllers will be used
126 * depending on wether news shall be displayed.
128 * @param $commandName A controller name we shall look for
129 * @return $controllerInstance A loaded controller instance
130 * @throws DefaultControllerException Thrown if even the default
131 * controller class is missing (bad!)
133 private function loadController ($commandName) {
135 //print("<strong>----- ".__METHOD__." -----</strong><pre>");
136 //debug_print_backtrace();
140 // Cache default command
141 $defaultCommand = $this->getConfigInstance()->readConfig('default_command');
143 // Init controller instance
144 $controllerInstance = null;
146 // Default controller
147 $class = "WebDefaultController";
149 // Generate the class name
150 //* DEBUG: */ echo __METHOD__.": Command=".$commandName;
151 if ($commandName != $defaultCommand) {
152 // Create controller class name
153 $class = sprintf("Web%sController",
154 $this->convertToClassName($commandName)
156 } elseif ($this->getConfigInstance()->readConfig('page_with_news') == $this->getApplicationInstance()->getRequestInstance()->getRequestElement('page')) {
157 // Yes, display news in home then set default controller with news
158 $class = "WebDefaultNewsController";
160 // No news at "home" page or non-news page
161 $class = "WebDefaultController";
163 //* DEBUG: */ echo ", controller=".$class."<br />\n";
165 // Is this class loaded?
166 if (!class_exists($class)) {
167 // Class not found, so try the default one or throw exception
168 if ($commandName != $defaultCommand) {
169 // Try the default controller
170 return $this->loadController($defaultCommand);
173 throw new DefaultControllerException($this, self::EXCEPTION_DEFAUL_CONTROLLER_GONE);
177 // Initiate the resolver and controller
178 $resolverInstance = ObjectFactory::createObjectByConfiguredName('web_cmd_resolver_class', array($commandName, $this->getApplicationInstance()));
179 $controllerInstance = ObjectFactory::createObjectByName($class, array($resolverInstance));
182 unset($resolverInstance);
185 return $controllerInstance;