X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fresolver%2Fcontroller%2Fclass_BaseControllerResolver.php;h=020438f133ed4cfcef02898fee873662ddb9ca17;hp=f324ec6d3a2bf4105f9d10c6af9929c51d51f29c;hb=66e68715d3d5a5e7fd5a3046471914ef3f9dd4b4;hpb=361e6320e50a8bb1a3ccb675388b8042361669ae diff --git a/inc/classes/main/resolver/controller/class_BaseControllerResolver.php b/inc/classes/main/resolver/controller/class_BaseControllerResolver.php index f324ec6d..020438f1 100644 --- a/inc/classes/main/resolver/controller/class_BaseControllerResolver.php +++ b/inc/classes/main/resolver/controller/class_BaseControllerResolver.php @@ -2,11 +2,11 @@ /** * A generic controller resolver class * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007 - 2009 Roland Haeder, this is free software + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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 @@ -22,15 +22,10 @@ * along with this program. If not, see . */ class BaseControllerResolver extends BaseResolver { - /** - * Prefix for local, remote or other resolver - */ - private $controllerPrefix = ""; - /** * Validated controller name */ - private $controllerName = ""; + private $controllerName = ''; /** * Protected constructor @@ -43,16 +38,6 @@ class BaseControllerResolver extends BaseResolver { parent::__construct($className); } - /** - * Setter for controller prefix - * - * @param $controllerPrefix Last validated controllerPrefix - * @return void - */ - protected final function setControllerPrefix ($controllerPrefix) { - $this->controllerPrefix = $controllerPrefix; - } - /** * Setter for controller name * @@ -73,16 +58,82 @@ class BaseControllerResolver extends BaseResolver { } /** - * Checks wether the given controller is valid + * "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 $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 function loadController ($controllerName) { + // Cache default command + $defaultController = $this->getConfigInstance()->getConfigEntry('default_' . strtolower($this->getClassPrefix()) . '_command'); + + // Init controller instance + $controllerInstance = NULL; + + // Default controller + $this->setClassName($this->getClassPrefix() . 'DefaultNewsController'); + + // Generate the class name + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BEFORE: controller=' . $controllerName); + if ($controllerName != $defaultController) { + // Create controller class name + $className = $this->getClassPrefix() . $this->convertToClassName($controllerName) . 'Controller'; + + // ... and set it + $this->setClassName($className); + } else { + // No news at main command or non-news command + $this->setClassName($this->getClassPrefix() . '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 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)) { @@ -90,27 +141,21 @@ class BaseControllerResolver extends BaseResolver { throw new EmptyVariableException(array($this, 'controllerName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING); } // END - if + // Create class name + $className = $this->getClassPrefix() . $this->convertToClassName($controllerName) . 'Controller'; + // Now, let us create the full name of the controller class - $this->setClassName(sprintf("%s%sController", - $this->controllerPrefix, - $this->convertToClassName($controllerName) - )); + $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')) { - // Do we have news? - if ($this->getConfigInstance()->readConfig('page_with_news') == $this->getApplicationInstance()->getRequestInstance()->getRequestElement('page')) { - // Yes, display news in home then set default controller with news - $this->setClassName($this->controllerPrefix . 'DefaultNewsController'); - } else { - // No news at home page or non-news page - $this->setClassName($this->controllerPrefix . 'DefaultController'); - } + $isValid = TRUE; + } elseif ($this->getClassName() != $this->getClassPrefix() . 'DefaultNewsController') { + // Set default controller + $this->setClassName($this->getClassPrefix() . 'DefaultNewsController'); } else { // All is tried, give it up here throw new DefaultControllerException($this, self::EXCEPTION_DEFAULT_CONTROLLER_GONE);