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 - 2015 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 ConsoleCommandResolver extends BaseCommandResolver implements CommandResolver {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set prefix to "Console"
35 $this->setClassPrefix('console');
39 * Creates an instance of a Console command resolver with a given default command
41 * @param $commandName The default command we shall execute
42 * @param $applicationInstance An instance of a manageable application helper class
43 * @return $resolverInstance The prepared command resolver instance
44 * @throws EmptyVariableException Thrown if default command is not set
45 * @throws InvalidCommandException Thrown if default command is invalid
47 public static final function createConsoleCommandResolver ($commandName, ManageableApplication $applicationInstance) {
48 // Create the new instance
49 $resolverInstance = new ConsoleCommandResolver();
51 // Is the variable $commandName set and the command is valid?
52 if (empty($commandName)) {
53 // Then thrown an exception here
54 throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
55 } elseif ($resolverInstance->isCommandValid($commandName) === FALSE) {
56 // Invalid command found
57 throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
60 // Set the application instance
61 $resolverInstance->setApplicationInstance($applicationInstance);
63 // Return the prepared instance
64 return $resolverInstance;
68 * Returns an command instance for a given request class or null if
71 * @param $requestInstance An instance of a request class
72 * @return $commandInstance An instance of the resolved command
73 * @throws InvalidCommandException Thrown if $commandName is
75 * @throws InvalidCommandInstanceException Thrown if $commandInstance
76 * is an invalid instance
78 public function resolveCommandByRequest (Requestable $requestInstance) {
81 $commandInstance = NULL;
83 // This goes fine so let's resolve the command
84 $commandName = $requestInstance->getRequestElement('command');
86 // Is the command empty? Then fall back to default command
87 if (empty($commandName)) {
88 $commandName = $this->getConfigInstance()->getConfigEntry('default_console_command');
91 // Check if command is valid
92 if ($this->isCommandValid($commandName) === FALSE) {
93 // This command is invalid!
94 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
98 $commandInstance = $this->loadCommand($commandName);
101 if ((!is_object($commandInstance)) || (!$commandInstance instanceof Commandable)) {
102 // This command has an invalid instance!
103 throw new InvalidCommandInstanceException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
107 $this->setResolvedInstance($commandInstance);
109 // Return the resolved command instance
110 return $commandInstance;
114 * Resolves the command by its direct name and returns an instance of its class
116 * @param $commandName The direct command name we shall resolve
117 * @return $commandInstance An instance of the command class
118 * @throws InvalidCommandException Thrown if $commandName is invalid
120 public function resolveCommand ($commandName) {
121 // Initiate the instance variable
122 $commandInstance = NULL;
124 // Is the command empty? Then fall back to default command
125 if (empty($commandName)) {
126 $commandName = $this->getConfigInstance()->getConfigEntry('default_console_command');
129 // Check if command is valid
130 if ($this->isCommandValid($commandName) === FALSE) {
131 // This command is invalid!
132 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
136 $commandInstance = $this->loadCommand($commandName);
138 // Return the instance
139 return $commandInstance;
143 * "Loads" a given command and instances it if not yet cached
145 * @param $commandName A command name we shall look for
146 * @return $commandInstance A loaded command instance
147 * @throws InvalidCommandException Thrown if even the default
148 * command class is missing (bad!)
150 private function loadCommand ($commandName) {
151 // Init command instance
152 $commandInstance = NULL;
155 $className = $this->getCapitalizedClassPrefix() . $this->convertToClassName($commandName) . 'Command';
157 // Create command class name
158 $this->setClassName($className);
160 // Is this class loaded?
161 if (!class_exists($this->getClassName())) {
162 // Class not found, so throw an exception
163 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
166 // Initiate the command
167 $commandInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
170 return $commandInstance;