/**
* A command resolver for local (non-hubbed) web commands
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.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
/**
* Last successfull resolved command
*/
- private $lastCommandInstance = null;
+ private $lastCommandInstance = NULL;
/**
* Protected constructor
parent::__construct(__CLASS__);
// Set prefix to "Web"
- $this->setCommandPrefix("Web");
+ $this->setClassPrefix('web');
}
/**
* Creates an instance of a Web command resolver with a given default command
*
* @param $commandName The default command we shall execute
- * @param $appInstance An instance of a manageable application helper class
+ * @param $applicationInstance An instance of a manageable application helper class
* @return $resolverInstance The prepared command resolver instance
* @throws EmptyVariableException Thrown if default command is not set
* @throws InvalidCommandException Thrown if default command is invalid
*/
- public final static function createWebCommandResolver ($commandName, ManageableApplication $appInstance) {
+ public static final function createWebCommandResolver ($commandName, ManageableApplication $applicationInstance) {
// Create the new instance
$resolverInstance = new WebCommandResolver();
if (empty($commandName)) {
// Then thrown an exception here
throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
- } elseif ($resolverInstance->isCommandValid($commandName) === false) {
+ } elseif ($resolverInstance->isCommandValid($commandName) === FALSE) {
// Invalid command found
throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
}
// Set the application instance
- $resolverInstance->setApplicationInstance($appInstance);
+ $resolverInstance->setApplicationInstance($applicationInstance);
// Return the prepared instance
return $resolverInstance;
}
-
- /**
- * Returns an command instance for a given request class or null if
- * it was not found
- *
- * @param $requestInstance An instance of a request class
- * @return $commandInstance An instance of the resolved command
- * @throws InvalidCommandException Thrown if $commandName is
- * invalid
- * @throws InvalidCommandInstanceException Thrown if $commandInstance
- * is an invalid instance
- */
- public function resolveCommandByRequest (Requestable $requestInstance) {
- // Init variables
- $commandName = "";
- $commandInstance = null;
-
- // This goes fine so let's resolv the command
- $commandName = $requestInstance->getRequestElement('page');
-
- // Is the command empty? Then fall back to default command
- if (empty($commandName)) $commandName = $this->getConfigInstance()->readConfig('default_web_command');
-
- // Check if command is valid
- if ($this->isCommandValid($commandName) === false) {
- // This command is invalid!
- throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
- } // END - if
-
- // Get the command
- $commandInstance = $this->loadCommand($commandName);
-
- // And validate it
- if ((!is_object($commandInstance)) || (!$commandInstance instanceof Commandable)) {
- // This command has an invalid instance!
- throw new InvalidCommandInstanceException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
- } // END - if
-
- // Set last command
- $this->lastCommandInstance = $commandInstance;
-
- // Return the resolved command instance
- return $commandInstance;
- }
-
- /**
- * Resolves the command by its direct name and returns an instance of its class
- *
- * @param $commandName The direct command name we shall resolve
- * @return $commandInstance An instance of the command class
- * @throws InvalidCommandException Thrown if $commandName is invalid
- */
- public function resolveCommand ($commandName) {
- // Initiate the instance variable
- $commandInstance = null;
-
- // Is the command empty? Then fall back to default command
- if (empty($commandName)) $commandName = $this->getConfigInstance()->readConfig('default_web_command');
-
- // Check if command is valid
- if ($this->isCommandValid($commandName) === false) {
- // This command is invalid!
- throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
- }
-
- // Get the command
- $commandInstance = $this->loadCommand($commandName);
-
- // Return the instance
- return $commandInstance;
- }
-
- /**
- * "Loads" a given command and instances it if not yet cached
- *
- * @param $commandName A command name we shall look for
- * @return $commandInstance A loaded command instance
- * @throws InvalidCommandException Thrown if even the default
- * command class is missing (bad!)
- */
- private function loadCommand ($commandName) {
- // Cache default command
- $defaultCommand = $this->getConfigInstance()->readConfig('default_web_command');
-
- // Init command instance
- $commandInstance = null;
-
- // Create command class name
- $this->setClassName(sprintf("Web%sCommand",
- $this->convertToClassName($commandName)
- ));
-
- // Is this class loaded?
- if (!class_exists($this->getClassName())) {
- // Class not found, so throw an exception
- throw new InvalidCommandException(array($this, $defaultCommand), self::EXCEPTION_INVALID_COMMAND);
- } // END - if
-
- // Initiate the command
- $commandInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
-
- // Return the result
- return $commandInstance;
- }
}
// [EOF]
projects / core.git / blobdiff