3 * A generic command resolver class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
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 * A controller instance
38 private $controllerInstance = null;
41 * Protected constructor
43 * @param $className Name of the class
46 protected function __construct ($className) {
47 // Call parent constructor
48 parent::__construct($className);
52 * Setter for command prefix
54 * @param $commandPrefix Last validated commandPrefix
57 protected final function setCommandPrefix ($commandPrefix) {
58 $this->commandPrefix = $commandPrefix;
62 * Setter for command name
64 * @param $commandName Last validated command name
67 protected final function setCommandName ($commandName) {
68 $this->commandName = $commandName;
72 * Getter for command name
74 * @return $commandName Last validated command name
76 protected final function getCommandName () {
77 return $this->commandName;
81 * Setter for controller instance (this surely breaks a bit the MVC patterm)
83 * @param $controllerInstance An instance of the controller
86 public final function setControllerInstance (Controller $controllerInstance) {
87 $this->controllerInstance = $controllerInstance;
91 * Getter for controller instance (this surely breaks a bit the MVC patterm)
93 * @return $controllerInstance An instance of the controller
95 public final function getControllerInstance () {
96 return $this->controllerInstance;
100 * Checks wether the given command is valid
102 * @param $commandName The default command we shall execute
103 * @return $isValid Wether the given command is valid
104 * @throws EmptyVariableException Thrown if the given command is not set
106 public function isCommandValid ($commandName) {
107 // By default nothing shall be valid
111 if (empty($commandName)) {
112 // Then thrown an exception here
113 throw new EmptyVariableException(array($this, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
116 // Now, let us create the full name of the command class
117 $this->setClassName(sprintf("%s%sCommand",
118 $this->commandPrefix,
119 $this->convertToClassName($commandName)
122 // Is this class already loaded?
123 if (class_exists($this->getClassName())) {
124 // This class does exist. :-)
129 //* DEBUG: */ $this->debugBackTrace();
132 $this->setCommandName($commandName);