3 * A generic command resolver class
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 BaseCommandResolver extends BaseResolver {
26 * Validated command name
28 private $commandName = '';
31 * Protected constructor
33 * @param $className Name of the class
36 protected function __construct ($className) {
37 // Call parent constructor
38 parent::__construct($className);
42 * Setter for command name
44 * @param $commandName Last validated command name
47 protected final function setCommandName ($commandName) {
48 $this->commandName = $commandName;
52 * Getter for command name
54 * @return $commandName Last validated command name
56 protected final function getCommandName () {
57 return $this->commandName;
61 * "Loads" a given command and instances it if not yet cached
63 * @param $commandName A command name we shall look for
64 * @return $commandInstance A loaded command instance
65 * @throws InvalidCommandException Thrown if even the default
66 * command class is missing (bad!)
68 protected function loadCommand ($commandName) {
69 // Init command instance
70 $commandInstance = NULL;
73 $className = $this->getCapitalizedClassPrefix() . $this->convertToClassName($commandName) . 'Command';
75 // Create command class name
76 $this->setClassName($className);
78 // Is this class loaded?
79 if (!class_exists($this->getClassName())) {
80 // Class not found, so throw an exception
81 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
84 // Initiate the command
85 $commandInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
88 return $commandInstance;
92 * Returns an command instance for a given request class or null if
95 * @param $requestInstance An instance of a request class
96 * @return $commandInstance An instance of the resolved command
97 * @throws InvalidCommandException Thrown if $commandName is
99 * @throws InvalidCommandInstanceException Thrown if $commandInstance
100 * is an invalid instance
102 public function resolveCommandByRequest (Requestable $requestInstance) {
105 $commandInstance = NULL;
107 // This goes fine so let's resolve the command
108 $commandName = $requestInstance->getRequestElement('command');
110 // Is the command empty? Then fall back to default command
111 if (empty($commandName)) {
112 $commandName = $this->getConfigInstance()->getConfigEntry('default_html_command');
115 // Check if command is valid
116 if ($this->isCommandValid($commandName) === FALSE) {
117 // This command is invalid!
118 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
122 $commandInstance = $this->loadCommand($commandName);
125 if ((!is_object($commandInstance)) || (!$commandInstance instanceof Commandable)) {
126 // This command has an invalid instance!
127 throw new InvalidCommandInstanceException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
131 $this->setResolvedInstance($commandInstance);
133 // Return the resolved command instance
134 return $commandInstance;
138 * Resolves the command by its direct name and returns an instance of its class
140 * @param $commandName The direct command name we shall resolve
141 * @return $commandInstance An instance of the command class
142 * @throws InvalidCommandException Thrown if $commandName is invalid
144 public function resolveCommand ($commandName) {
145 // Initiate the instance variable
146 $commandInstance = NULL;
148 // Is the command empty? Then fall back to default command
149 if (empty($commandName)) {
150 $commandName = $this->getConfigInstance()->getConfigEntry('default_html_command');
153 // Check if command is valid
154 if ($this->isCommandValid($commandName) === FALSE) {
155 // This command is invalid!
156 throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
160 $commandInstance = $this->loadCommand($commandName);
162 // Return the instance
163 return $commandInstance;
167 * Checks whether the given command is valid
169 * @param $commandName The default command we shall execute
170 * @return $isValid Whether the given command is valid
171 * @throws EmptyVariableException Thrown if given command is not set
173 public function isCommandValid ($commandName) {
174 // By default nothing shall be valid
178 if (empty($commandName)) {
179 // Then thrown an exception here
180 throw new EmptyVariableException(array($this, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
183 // Create the full class name
184 $className = $this->getCapitalizedClassPrefix() . $this->convertToClassName($commandName) . 'Command';
186 // Now, let us create the full name of the command class
187 $this->setClassName($className);
189 // Is this class already loaded?
190 if (class_exists($this->getClassName())) {
191 // This class does exist. :-)
196 $this->setCommandName($commandName);