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
45 protected function __construct ($className) {
46 // Call parent constructor
47 parent::__construct($className);
51 * Setter for command prefix
53 * @param $commandPrefix Last validated commandPrefix
56 protected final function setCommandPrefix ($commandPrefix) {
57 $this->commandPrefix = $commandPrefix;
61 * Setter for command name
63 * @param $commandName Last validated command name
66 protected final function setCommandName ($commandName) {
67 $this->commandName = $commandName;
71 * Getter for command name
73 * @return $commandName Last validated command name
75 protected final function getCommandName () {
76 return $this->commandName;
80 * Setter for controller instance (this surely breaks a bit the MVC patterm)
82 * @param $controllerInstance An instance of the controller
85 public final function setControllerInstance (Controller $controllerInstance) {
86 $this->controllerInstance = $controllerInstance;
90 * Getter for controller instance (this surely breaks a bit the MVC patterm)
92 * @return $controllerInstance An instance of the controller
94 public final function getControllerInstance () {
95 return $this->controllerInstance;
99 * Checks wether the given command is valid
101 * @param $commandName The default command we shall execute
102 * @return $isValid Wether the given command is valid
103 * @throws EmptyVariableException Thrown if the given command is not set
105 public function isCommandValid ($commandName) {
106 // By default nothing shall be valid
110 if (empty($commandName)) {
111 // Then thrown an exception here
112 throw new EmptyVariableException(array($this, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
115 // Now, let us create the full name of the command class
116 $className = sprintf("%s%sCommand",
117 $this->commandPrefix,
118 $this->convertToClassName($commandName)
121 // Is this class already loaded?
122 if (class_exists($className)) {
123 // This class does exist. :-)
128 //* DEBUG: */ $this->debugBacktrace();
131 $this->setCommandName($commandName);