3 * A generic command resolver class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 * Prefix for local, remote or other resolver
28 private $commandPrefix = '';
31 * Validated command name
33 private $commandName = '';
36 * Protected constructor
38 * @param $className Name of the class
41 protected function __construct ($className) {
42 // Call parent constructor
43 parent::__construct($className);
47 * Getter for command prefix
49 * @return $commandPrefix Last validated commandPrefix
51 protected final function getCommandPrefix () {
52 return $this->commandPrefix;
56 * Setter for command prefix
58 * @param $commandPrefix Last validated commandPrefix
61 protected final function setCommandPrefix ($commandPrefix) {
62 $this->commandPrefix = $commandPrefix;
66 * Setter for command name
68 * @param $commandName Last validated command name
71 protected final function setCommandName ($commandName) {
72 $this->commandName = $commandName;
76 * Getter for command name
78 * @return $commandName Last validated command name
80 protected final function getCommandName () {
81 return $this->commandName;
85 * Checks wether the given command is valid
87 * @param $commandName The default command we shall execute
88 * @return $isValid Wether the given command is valid
89 * @throws EmptyVariableException Thrown if given command is not set
91 public function isCommandValid ($commandName) {
92 // By default nothing shall be valid
96 if (empty($commandName)) {
97 // Then thrown an exception here
98 throw new EmptyVariableException(array($this, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
101 // Create the full class name
102 $className = $this->commandPrefix . $this->convertToClassName($commandName) . 'Command';
104 // Now, let us create the full name of the command class
105 $this->setClassName($className);
107 // Is this class already loaded?
108 if (class_exists($this->getClassName())) {
109 // This class does exist. :-)
114 $this->setCommandName($commandName);