X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fresolver%2Fcommand%2Fclass_BaseCommandResolver.php;fp=inc%2Fclasses%2Fmain%2Fresolver%2Fcommand%2Fclass_BaseCommandResolver.php;h=f26d351fa6d4c7536c050868f96198de2ad0f813;hp=0000000000000000000000000000000000000000;hb=2230a2e7e09b6b47fe3d68181a28a4435c1732e6;hpb=4365745a3952764d684556852c31d0e8cba5e58e

diff --git a/inc/classes/main/resolver/command/class_BaseCommandResolver.php b/inc/classes/main/resolver/command/class_BaseCommandResolver.php
new file mode 100644
index 0000000000..f26d351fa6
--- /dev/null
+++ b/inc/classes/main/resolver/command/class_BaseCommandResolver.php
@@ -0,0 +1,140 @@
+<?php
+/**
+ * A generic command resolver class
+ *
+ * @author		Roland Haeder <webmaster@ship-simu.org>
+ * @version		0.0.0
+ * @copyright	Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @license		GNU GPL 3.0 or any newer version
+ * @link		http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class BaseCommandResolver extends BaseResolver {
+	/**
+	 * Prefix for local, remote or other resolver
+	 */
+	private $commandPrefix = "";
+
+	/**
+	 * Validated command name
+	 */
+	private $commandName = "";
+
+	/**
+	 * A controller instance
+	 */
+	private $controllerInstance = null;
+
+	/**
+	 * Protected constructor
+	 *
+	 * @param	$className	Name of the class
+	 * @return	void
+	 */
+	protected function __construct ($className) {
+		// Call parent constructor
+		parent::__construct($className);
+	}
+
+	/**
+	 * Setter for command prefix
+	 *
+	 * @param	$commandPrefix	Last validated commandPrefix
+	 * @return	void
+	 */
+	protected final function setCommandPrefix ($commandPrefix) {
+		$this->commandPrefix = $commandPrefix;
+	}
+
+	/**
+	 * Setter for command name
+	 *
+	 * @param	$commandName	Last validated command name
+	 * @return	void
+	 */
+	protected final function setCommandName ($commandName) {
+		$this->commandName = $commandName;
+	}
+
+	/**
+	 * Getter for command name
+	 *
+	 * @return	$commandName	Last validated command name
+	 */
+	protected final function getCommandName () {
+		return $this->commandName;
+	}
+
+	/**
+	 * Setter for controller instance (this surely breaks a bit the MVC patterm)
+	 *
+	 * @param	$controllerInstance		An instance of the controller
+	 * @return	void
+	 */
+	public final function setControllerInstance (Controller $controllerInstance) {
+		$this->controllerInstance = $controllerInstance;
+	}
+
+	/**
+	 * Getter for controller instance (this surely breaks a bit the MVC patterm)
+	 *
+	 * @return	$controllerInstance		An instance of the controller
+	 */
+	public final function getControllerInstance () {
+		return $this->controllerInstance;
+	}
+
+	/**
+	 * Checks wether the given command is valid
+	 *
+	 * @param	$commandName	The default command we shall execute
+	 * @return	$isValid		Wether the given command is valid
+	 * @throws	EmptyVariableException	Thrown if the given command is not set
+	 */
+	public function isCommandValid ($commandName) {
+		// By default nothing shall be valid
+		$isValid = false;
+
+		// Is a command set?
+		if (empty($commandName)) {
+			// Then thrown an exception here
+			throw new EmptyVariableException(array($this, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
+		}
+
+		// Now, let us create the full name of the command class
+		$this->setClassName(sprintf("%s%sCommand",
+			$this->commandPrefix,
+			$this->convertToClassName($commandName)
+		));
+
+		// Is this class already loaded?
+		if (class_exists($this->getClassName())) {
+			// This class does exist. :-)
+			$isValid = true;
+		} // END - if
+
+		// Debug output
+		//* DEBUG: */ $this->debugBackTrace();
+
+		// Set command name
+		$this->setCommandName($commandName);
+
+		// Return the result
+		return $isValid;
+	}
+}
+
+// [EOF]
+?>