X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fresolver%2Fcontroller%2Fclass_BaseControllerResolver.php;h=b9ae868f6fe732367fb1ceb1239427a3924bd3c2;hp=85662f67546c8282619cfcca6a86ca326a4f3807;hb=80f58e52514b2fca93a2d37977a6874ece9b1e54;hpb=c2af8937094327995b326de0d7a0ca117b44aae0 diff --git a/inc/classes/main/resolver/controller/class_BaseControllerResolver.php b/inc/classes/main/resolver/controller/class_BaseControllerResolver.php index 85662f67..b9ae868f 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, 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 @@ -22,16 +22,6 @@ * 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 = ''; - /** * Protected constructor * @@ -43,49 +33,10 @@ 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; - } - - /** - * Getter for controller prefix - * - * @param $controllerPrefix Last validated controllerPrefix - * @return void - */ - protected final function getControllerPrefix () { - return $this->controllerPrefix; - } - - /** - * Setter for controller name - * - * @param $controllerName Last validated controller name - * @return void - */ - protected final function setControllerName ($controllerName) { - $this->controllerName = $controllerName; - } - - /** - * Getter for controller name - * - * @return $controllerName Last validated controller name - */ - public final function getControllerName () { - return $this->controllerName; - } - /** * "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 wether news shall be displayed. + * depending on whether news shall be displayed. * * @param $controllerName A controller name we shall look for * @return $controllerInstance A loaded controller instance @@ -94,27 +45,27 @@ class BaseControllerResolver extends BaseResolver { */ protected function loadController ($controllerName) { // Cache default command - $defaultController = $this->getConfigInstance()->readConfig('default_' . strtolower($this->getControllerPrefix()) . '_command'); + $defaultController = $this->getConfigInstance()->getConfigEntry('default_' . strtolower($this->getClassPrefix()) . '_command'); // Init controller instance - $controllerInstance = null; + $controllerInstance = NULL; // Default controller - $this->setClassName($this->getControllerPrefix() . 'DefaultNewsController'); + $this->setClassName($this->getCapitalizedClassPrefix() . 'DefaultNewsController'); // Generate the class name - //* DEBUG: */ echo __METHOD__.": Controller=".$controllerName; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BEFORE: controller=' . $controllerName); if ($controllerName != $defaultController) { // Create controller class name - $className = $this->getControllerPrefix() . '' . $this->convertToClassName($controllerName) . 'Controller'; + $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->getControllerPrefix() . 'DefaultNewsController'); + $this->setClassName($this->getCapitalizedClassPrefix() . 'DefaultNewsController'); } - //* DEBUG: */ echo ", controller=".$this->getClassName()."
\n"; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('AFTER: controller=' . $this->getClassName()); // Is this class loaded? if (!class_exists($this->getClassName())) { @@ -126,17 +77,10 @@ class BaseControllerResolver extends BaseResolver { $resolverConfigEntry = ''; // Try to read a config entry for our resolver including controller name... ;-) - try { - // Create the resolver name - $resolverConfigEntry = sprintf("%s_cmd_%s_resolver_class", strtolower($this->getControllerPrefix()), strtolower($controllerName)); - - // Get the config, this will throw an exception if there is no special command resolver - $resolverClass = $this->getConfigInstance()->readConfig($resolverConfigEntry); - } catch (ConfigEntryNotFoundException $e) { - // Use default resolver entry - // @TODO Maybe we need to log this? - $resolverConfigEntry = strtolower($this->getControllerPrefix()) . '_cmd_resolver_class'; - } + $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( @@ -156,16 +100,16 @@ class BaseControllerResolver extends BaseResolver { } /** - * 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)) { @@ -174,20 +118,20 @@ class BaseControllerResolver extends BaseResolver { } // 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.'DefaultNewsController') { + $isValid = TRUE; + } elseif ($this->getClassName() != $this->getCapitalizedClassPrefix() . 'DefaultNewsController') { // Set default controller - $this->setClassName($this->controllerPrefix . 'DefaultNewsController'); + $this->setClassName($this->getCapitalizedClassPrefix() . 'DefaultNewsController'); } else { // All is tried, give it up here throw new DefaultControllerException($this, self::EXCEPTION_DEFAULT_CONTROLLER_GONE); @@ -197,6 +141,38 @@ class BaseControllerResolver extends BaseResolver { // 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]