/**
* A generic controller resolver class
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
class BaseControllerResolver extends BaseResolver {
- /**
- * Prefix for local, remote or other resolver
- */
- private $controllerPrefix = '';
-
- /**
- * Validated controller name
- */
- private $controllerName = '';
-
/**
* Protected constructor
*
}
/**
- * Setter for controller prefix
+ * "Loads" a given controller and instances it if not yet cached. If the
+ * controller was not found one of the default controllers will be used
+ * depending on whether news shall be displayed.
*
- * @param $controllerPrefix Last validated controllerPrefix
- * @return void
+ * @param $controllerName A controller name we shall look for
+ * @return $controllerInstance A loaded controller instance
+ * @throws InvalidControllerException Thrown if even the requested
+ * controller class is missing (bad!)
*/
- protected final function setControllerPrefix ($controllerPrefix) {
- $this->controllerPrefix = $controllerPrefix;
- }
+ protected function loadController ($controllerName) {
+ // Cache default command
+ $defaultController = $this->getConfigInstance()->getConfigEntry('default_' . strtolower($this->getClassPrefix()) . '_command');
- /**
- * Setter for controller name
- *
- * @param $controllerName Last validated controller name
- * @return void
- */
- protected final function setControllerName ($controllerName) {
- $this->controllerName = $controllerName;
- }
+ // Init controller instance
+ $controllerInstance = NULL;
- /**
- * Getter for controller name
- *
- * @return $controllerName Last validated controller name
- */
- public final function getControllerName () {
- return $this->controllerName;
+ // Default controller
+ $this->setClassName($this->getCapitalizedClassPrefix() . 'DefaultNewsController');
+
+ // Generate the class name
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BEFORE: controller=' . $controllerName);
+ if ($controllerName != $defaultController) {
+ // Create controller class name
+ $className = $this->getCapitalizedClassPrefix() . $this->convertToClassName($controllerName) . 'Controller';
+
+ // ... and set it
+ $this->setClassName($className);
+ } else {
+ // No news at main command or non-news command
+ $this->setClassName($this->getCapitalizedClassPrefix() . 'DefaultNewsController');
+ }
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('AFTER: controller=' . $this->getClassName());
+
+ // Is this class loaded?
+ if (!class_exists($this->getClassName())) {
+ // Throw an exception here
+ throw new InvalidControllerException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
+ } // END - if
+
+ // Set default resolver config name
+ $resolverConfigEntry = '';
+
+ // Try to read a config entry for our resolver including controller name... ;-)
+ $resolverConfigEntry = sprintf('%s_cmd_%s_resolver_class', strtolower($this->getClassPrefix()), strtolower($controllerName));
+
+ // Get the config, this will throw an exception if there is no special command resolver
+ $resolverClass = $this->getConfigInstance()->getConfigEntry($resolverConfigEntry);
+
+ // Initiate the resolver and controller
+ $resolverInstance = ObjectFactory::createObjectByConfiguredName(
+ $resolverConfigEntry,
+ array(
+ $controllerName,
+ $this->getApplicationInstance()
+ )
+ );
+ $controllerInstance = ObjectFactory::createObjectByName(
+ $this->getClassName(),
+ array($resolverInstance)
+ );
+
+ // Return the result
+ return $controllerInstance;
}
/**
- * Checks wether the given controller is valid
+ * Checks whether the given controller is valid
*
* @param $controllerName The default controller we shall execute
- * @return $isValid Wether the given controller is valid
+ * @return $isValid Whether the given controller is valid
* @throws EmptyVariableException Thrown if given controller is not set
* @throws DefaultControllerException Thrown if default controller was not found
*/
public function isControllerValid ($controllerName) {
// By default nothing shall be valid
- $isValid = false;
+ $isValid = FALSE;
// Is a controller set?
if (empty($controllerName)) {
} // END - if
// Create class name
- $className = $this->controllerPrefix . $this->convertToClassName($controllerName) . 'Controller';
+ $className = $this->getCapitalizedClassPrefix() . $this->convertToClassName($controllerName) . 'Controller';
// Now, let us create the full name of the controller class
$this->setClassName($className);
// Try it hard to get an controller
- while ($isValid === false) {
+ while ($isValid === FALSE) {
// Is this class already loaded?
if (class_exists($this->getClassName())) {
// This class does exist. :-)
- $isValid = true;
- } elseif (($this->getClassName() != $this->controllerPrefix.'DefaultController') && ($this->getClassName() != $this->controllerPrefix.'DefaultNewsController')) {
+ $isValid = TRUE;
+ } elseif ($this->getClassName() != $this->getCapitalizedClassPrefix() . 'DefaultNewsController') {
// Set default controller
- $this->setClassName($this->controllerPrefix . 'DefaultController');
+ $this->setClassName($this->getCapitalizedClassPrefix() . 'DefaultNewsController');
} else {
// All is tried, give it up here
throw new DefaultControllerException($this, self::EXCEPTION_DEFAULT_CONTROLLER_GONE);
// Return the result
return $isValid;
}
+
+ /**
+ * Resolves the default controller of the given command
+ *
+ * @return $controllerInstance A controller instance for the default
+ * command
+ * @throws InvalidControllerInstanceException Thrown if $controllerInstance
+ * is invalid
+ */
+ public function resolveController () {
+ // Init variables
+ $controllerName = '';
+ $controllerInstance = NULL;
+
+ // Get the command name
+ $controllerName = $this->getControllerName();
+
+ // Get the command
+ $controllerInstance = $this->loadController($controllerName);
+
+ // And validate it
+ if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) {
+ // This command has an invalid instance!
+ throw new InvalidControllerInstanceException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
+ } // END - if
+
+ // Set last controller
+ $this->setResolvedInstance($controllerInstance);
+
+ // Return the maybe resolved instance
+ return $controllerInstance;
+ }
}
// [EOF]
projects / core.git / blobdiff