3 * A resolver for resolving controllers locally
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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 HubConsoleControllerResolver extends BaseControllerResolver implements ControllerResolver {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set prefix to "HubConsole"
35 $this->setClassPrefix('HubConsole');
39 * Creates an instance of a resolver class with a given command
41 * @param $controllerName The controller we shall resolve
42 * @param $applicationInstance An instance of a manageable application helper class
43 * @return $resolverInstance The prepared controller resolver instance
44 * @throws EmptyVariableException Thrown if default command is not set
45 * @throws InvalidControllerException Thrown if default controller is invalid
47 public static final function createHubConsoleControllerResolver ($controllerName, ManageableApplication $applicationInstance) {
48 // Create the new instance
49 $resolverInstance = new HubConsoleControllerResolver();
51 // Is the variable $controllerName set and the command is valid?
52 if (empty($controllerName)) {
53 // Then thrown an exception here
54 throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
55 } elseif ($resolverInstance->isControllerValid($controllerName) === FALSE) {
56 // Invalid command found
57 throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
60 // Set the application instance
61 $resolverInstance->setApplicationInstance($applicationInstance);
64 $resolverInstance->setControllerName($controllerName);
66 // Return the prepared instance
67 return $resolverInstance;
71 * Resolves the default controller of the given command
73 * @return $controllerInstance A controller instance for the default
75 * @throws InvalidControllerInstanceException Thrown if $controllerInstance
78 public function resolveController () {
81 $controllerInstance = NULL;
83 // Get the command name
84 $controllerName = $this->getControllerName();
87 $controllerInstance = $this->loadController($controllerName);
90 if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) {
91 // This command has an invalid instance!
92 throw new InvalidControllerInstanceException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
95 // Set last controller
96 $this->setResolvedInstance($controllerInstance);
98 // Return the maybe resolved instance
99 return $controllerInstance;