3 * A command resolver for local (non-hubbed) web commands including the failed government request
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu 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 HtmlGovernmentFailedCommandResolver 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 "Html"
40 $this->setCommandPrefix('Html');
44 * Creates an instance of a Html command resolver with a given default command
46 * @param $commandName The default command we shall execute
47 * @param $appInstance 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 InvalidInterfaceException Thrown if command does not implement interface Commandable
52 public static final function createHtmlGovernmentFailedCommandResolver ($commandName, ManageableApplication $appInstance) {
53 // Create the new instance
54 $resolverInstance = new HtmlGovernmentFailedCommandResolver();
56 // Get request instance
57 $requestInstance = $appInstance->getRequestInstance();
59 // Is the variable $commandName set and the command is valid?
60 if (empty($commandName)) {
61 // Then thrown an exception here
62 throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
63 } elseif (!$resolverInstance->resolveCommandByRequest($requestInstance) instanceof Commandable) {
64 // Invalid command found (missing interface?)
65 throw new InvalidInterfaceException(array($userInstance, 'ManageableMember'), self::EXCEPTION_REQUIRED_INTERFACE_MISSING);
68 // Set the application instance
69 $resolverInstance->setApplicationInstance($appInstance);
71 // Return the prepared instance
72 return $resolverInstance;
76 * Returns an command instance for a given request class or null if
79 * @param $requestInstance An instance of a request class
80 * @return $commandInstance An instance of the resolved command
81 * @throws InvalidCommandException Thrown if $commandName is
83 * @throws InvalidCommandInstanceException Thrown if $commandInstance
84 * is an invalid instance
86 public function resolveCommandByRequest (Requestable $requestInstance) {
88 $commandInstance = null;
90 // This goes fine so let's resolv the command
91 $commandName = $requestInstance->getRequestElement('page');
93 // Is there a "failed" request?
94 if ($requestInstance->isRequestElementSet('failed')) {
95 // Then include with within the command name
96 $commandName = sprintf('%s_%s', $commandName, $requestInstance->getRequestElement('failed'));
99 // Is the command empty? Then fall back to default command
100 if (empty($commandName)) $commandName = $this->getConfigInstance()->getConfigEntry('default_web_command');
102 // Check if command is valid
103 if ($this->isCommandValid($commandName) === false) {
104 // This command is invalid!
105 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
109 $commandInstance = $this->loadCommand($commandName);
112 if ((!is_object($commandInstance)) || (!$commandInstance instanceof Commandable)) {
113 // This command has an invalid instance!
114 throw new InvalidCommandInstanceException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
118 $this->lastCommandInstance = $commandInstance;
120 // Return the resolved command instance
121 return $commandInstance;
125 * Resolves the command by its direct name and returns an instance of its class
127 * @param $commandName The direct command name we shall resolve
128 * @return $commandInstance An instance of the command class
129 * @throws InvalidCommandException Thrown if $commandName is invalid
131 public function resolveCommand ($commandName) {
132 // Initiate the instance variable
133 $commandInstance = null;
135 // Is the command empty? Then fall back to default command
136 if (empty($commandName)) $commandName = $this->getConfigInstance()->getConfigEntry('default_web_command');
138 // Check if command is valid
139 if ($this->isCommandValid($commandName) === false) {
140 // This command is invalid!
141 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
145 $commandInstance = $this->loadCommand($commandName);
147 // Return the instance
148 return $commandInstance;
152 * "Loads" a given command and instances it if not yet cached
154 * @param $commandName A command name we shall look for
155 * @return $commandInstance A loaded command instance
156 * @throws InvalidCommandException Thrown if even the default
157 * command class is missing (bad!)
159 private function loadCommand ($commandName) {
160 // Cache default command
161 $defaultCommand = $this->getConfigInstance()->getConfigEntry('default_web_command');
163 // Init command instance
164 $commandInstance = null;
166 // Create command class name
167 $this->setClassName(sprintf('%s%sCommand',
168 $this->getCommandPrefix(),
169 $this->convertToClassName($commandName)
172 // Is this class loaded?
173 if (!class_exists($this->getClassName())) {
174 // Class not found, so throw an exception
175 throw new InvalidCommandException(array($this, $defaultCommand), self::EXCEPTION_INVALID_COMMAND);
178 // Initiate the command
179 $commandInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
182 return $commandInstance;