3 * A command resolver for local (non-hubbed) web commands
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core 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 WebCommandResolver extends BaseCommandResolver implements CommandResolver {
26 * Last successfull resolved command
28 private $lastCommandInstance = NULL;
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
39 // Set prefix to "Web"
40 $this->setClassPrefix('Web');
44 * Creates an instance of a Web command resolver with a given default command
46 * @param $commandName The default command we shall execute
47 * @param $applicationInstance An instance of a manageable application helper class
48 * @return $resolverInstance The prepared command resolver instance
49 * @throws EmptyVariableException Thrown if default command is not set
50 * @throws InvalidCommandException Thrown if default command is invalid
52 public static final function createWebCommandResolver ($commandName, ManageableApplication $applicationInstance) {
53 // Create the new instance
54 $resolverInstance = new WebCommandResolver();
56 // Is the variable $commandName set and the command is valid?
57 if (empty($commandName)) {
58 // Then thrown an exception here
59 throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
60 } elseif ($resolverInstance->isCommandValid($commandName) === FALSE) {
61 // Invalid command found
62 throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
65 // Set the application instance
66 $resolverInstance->setApplicationInstance($applicationInstance);
68 // Return the prepared instance
69 return $resolverInstance;
73 * Returns an command instance for a given request class or null if
76 * @param $requestInstance An instance of a request class
77 * @return $commandInstance An instance of the resolved command
78 * @throws InvalidCommandException Thrown if $commandName is
80 * @throws InvalidCommandInstanceException Thrown if $commandInstance
81 * is an invalid instance
83 public function resolveCommandByRequest (Requestable $requestInstance) {
86 $commandInstance = NULL;
88 // This goes fine so let's resolve the command
89 $commandName = $requestInstance->getRequestElement('page');
91 // Is the command empty? Then fall back to default command
92 if (empty($commandName)) {
93 $commandName = $this->getConfigInstance()->getConfigEntry('default_web_command');
96 // Check if command is valid
97 if ($this->isCommandValid($commandName) === FALSE) {
98 // This command is invalid!
99 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
103 $commandInstance = $this->loadCommand($commandName);
106 if ((!is_object($commandInstance)) || (!$commandInstance instanceof Commandable)) {
107 // This command has an invalid instance!
108 throw new InvalidCommandInstanceException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
112 $this->setResolvedInstance($commandInstance);
114 // Return the resolved command instance
115 return $commandInstance;
119 * Resolves the command by its direct name and returns an instance of its class
121 * @param $commandName The direct command name we shall resolve
122 * @return $commandInstance An instance of the command class
123 * @throws InvalidCommandException Thrown if $commandName is invalid
125 public function resolveCommand ($commandName) {
126 // Initiate the instance variable
127 $commandInstance = NULL;
129 // Is the command empty? Then fall back to default command
130 if (empty($commandName)) {
131 $commandName = $this->getConfigInstance()->getConfigEntry('default_web_command');
134 // Check if command is valid
135 if ($this->isCommandValid($commandName) === FALSE) {
136 // This command is invalid!
137 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
141 $commandInstance = $this->loadCommand($commandName);
143 // Return the instance
144 return $commandInstance;
148 * "Loads" a given command and instances it if not yet cached
150 * @param $commandName A command name we shall look for
151 * @return $commandInstance A loaded command instance
152 * @throws InvalidCommandException Thrown if even the default
153 * command class is missing (bad!)
155 private function loadCommand ($commandName) {
156 // Init command instance
157 $commandInstance = NULL;
159 // Is this class loaded?
160 if (!class_exists($this->getClassName())) {
161 // Class not found, so throw an exception
162 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
165 // Initiate the command
166 $commandInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
169 return $commandInstance;