3 * A generic controller resolver class
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 BaseControllerResolver extends BaseResolver {
26 * Prefix for local, remote or other resolver
28 private $controllerPrefix = '';
31 * Validated controller name
33 private $controllerName = '';
36 * Protected constructor
38 * @param $className Name of the real class
41 protected function __construct ($className) {
42 // Call parent constructor
43 parent::__construct($className);
47 * Setter for controller prefix
49 * @param $controllerPrefix Last validated controllerPrefix
52 protected final function setControllerPrefix ($controllerPrefix) {
53 $this->controllerPrefix = $controllerPrefix;
57 * Getter for controller prefix
59 * @param $controllerPrefix Last validated controllerPrefix
62 protected final function getControllerPrefix () {
63 return $this->controllerPrefix;
67 * Setter for controller name
69 * @param $controllerName Last validated controller name
72 protected final function setControllerName ($controllerName) {
73 $this->controllerName = $controllerName;
77 * Getter for controller name
79 * @return $controllerName Last validated controller name
81 public final function getControllerName () {
82 return $this->controllerName;
86 * "Loads" a given controller and instances it if not yet cached. If the
87 * controller was not found one of the default controllers will be used
88 * depending on wether news shall be displayed.
90 * @param $controllerName A controller name we shall look for
91 * @return $controllerInstance A loaded controller instance
92 * @throws InvalidControllerException Thrown if even the requested
93 * controller class is missing (bad!)
95 protected function loadController ($controllerName) {
96 // Cache default command
97 $defaultController = $this->getConfigInstance()->getConfigEntry('default_' . strtolower($this->getControllerPrefix()) . '_command');
99 // Init controller instance
100 $controllerInstance = null;
102 // Default controller
103 $this->setClassName($this->getControllerPrefix() . 'DefaultNewsController');
105 // Generate the class name
106 //* DEBUG: */ echo __METHOD__.": Controller=".$controllerName;
107 if ($controllerName != $defaultController) {
108 // Create controller class name
109 $className = $this->getControllerPrefix() . '' . $this->convertToClassName($controllerName) . 'Controller';
112 $this->setClassName($className);
114 // No news at main command or non-news command
115 $this->setClassName($this->getControllerPrefix() . 'DefaultNewsController');
117 //* DEBUG: */ echo ", controller=".$this->getClassName()."<br />\n";
119 // Is this class loaded?
120 if (!class_exists($this->getClassName())) {
121 // Throw an exception here
122 throw new InvalidControllerException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
125 // Set default resolver config name
126 $resolverConfigEntry = '';
128 // Try to read a config entry for our resolver including controller name... ;-)
130 // Create the resolver name
131 $resolverConfigEntry = sprintf("%s_cmd_%s_resolver_class", strtolower($this->getControllerPrefix()), strtolower($controllerName));
133 // Get the config, this will throw an exception if there is no special command resolver
134 $resolverClass = $this->getConfigInstance()->getConfigEntry($resolverConfigEntry);
135 } catch (ConfigEntryNotFoundException $e) {
136 // Use default resolver entry
137 // @TODO Maybe we need to log this?
138 $resolverConfigEntry = strtolower($this->getControllerPrefix()) . '_cmd_resolver_class';
141 // Initiate the resolver and controller
142 $resolverInstance = ObjectFactory::createObjectByConfiguredName(
143 $resolverConfigEntry,
146 $this->getApplicationInstance()
149 $controllerInstance = ObjectFactory::createObjectByName(
150 $this->getClassName(),
151 array($resolverInstance)
155 return $controllerInstance;
159 * Checks wether the given controller is valid
161 * @param $controllerName The default controller we shall execute
162 * @return $isValid Wether the given controller is valid
163 * @throws EmptyVariableException Thrown if given controller is not set
164 * @throws DefaultControllerException Thrown if default controller was not found
166 public function isControllerValid ($controllerName) {
167 // By default nothing shall be valid
170 // Is a controller set?
171 if (empty($controllerName)) {
172 // Then thrown an exception here
173 throw new EmptyVariableException(array($this, 'controllerName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
177 $className = $this->controllerPrefix . $this->convertToClassName($controllerName) . 'Controller';
179 // Now, let us create the full name of the controller class
180 $this->setClassName($className);
182 // Try it hard to get an controller
183 while ($isValid === false) {
184 // Is this class already loaded?
185 if (class_exists($this->getClassName())) {
186 // This class does exist. :-)
188 } elseif ($this->getClassName() != $this->controllerPrefix.'DefaultNewsController') {
189 // Set default controller
190 $this->setClassName($this->controllerPrefix . 'DefaultNewsController');
192 // All is tried, give it up here
193 throw new DefaultControllerException($this, self::EXCEPTION_DEFAULT_CONTROLLER_GONE);