3 * A generic 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 BaseResolver extends BaseFrameworkSystem {
26 * Validated command name
28 private $commandName = "";
31 * Prefix for local, remote or other resolver
33 private $commandPrefix = "";
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
45 $this->removeSystemArray();
49 * Setter for command name
51 * @param $commandName Last validated command name
54 protected final function setCommandName ($commandName) {
55 $this->commandName = $commandName;
59 * Getter for command name
61 * @return $commandName Last validated command name
63 protected final function getCommandName () {
64 return $this->commandName;
68 * Setter for command prefix
70 * @param $commandPrefix Last validated commandPrefix
73 protected final function setCommandPrefix ($commandPrefix) {
74 $this->commandPrefix = $commandPrefix;
78 * Checks wether the given command is valid
80 * @param $commandName The default command we shall execute
81 * @return $isValid Wether the given command is valid
82 * @throws EmptyVariableException Thrown if the given command is not set
84 public function isCommandValid ($commandName) {
85 // By default nothing shall be valid
89 if (empty($commandName)) {
90 // Then thrown an exception here
91 throw new EmptyVariableException(array($this, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
94 // Now, let us create the full name of the command class
95 $class = sprintf("%s%sCommand",
97 ucfirst(strtolower($commandName))
100 // Is this class already loaded?
101 if (class_exists($class)) {
102 // This class does exist. :-)
107 $this->setCommandName($commandName);