X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fresolver%2Fcontroller%2Fclass_BaseControllerResolver.php;fp=inc%2Fclasses%2Fmain%2Fresolver%2Fcontroller%2Fclass_BaseControllerResolver.php;h=0000000000000000000000000000000000000000;hp=5615515afc62531a2b84a2e158902b21e40fc5be;hb=751f9e6c51f00dba27757b72fc85490e51fd3797;hpb=5203f9bd014ad46fbc7ee54e7223dcd46e14e3b4 diff --git a/inc/classes/main/resolver/controller/class_BaseControllerResolver.php b/inc/classes/main/resolver/controller/class_BaseControllerResolver.php deleted file mode 100644 index 5615515a..00000000 --- a/inc/classes/main/resolver/controller/class_BaseControllerResolver.php +++ /dev/null @@ -1,179 +0,0 @@ - - * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team - * @license GNU GPL 3.0 or any newer version - * @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 - * 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 . - */ -class BaseControllerResolver extends BaseResolver { - /** - * Protected constructor - * - * @param $className Name of the real class - * @return void - */ - protected function __construct ($className) { - // Call parent constructor - parent::__construct($className); - } - - /** - * "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 controller - $defaultController = $this->getConfigInstance()->getConfigEntry('default_' . strtolower($this->getClassPrefix()) . '_controller'); - - // Init controller instance - $controllerInstance = NULL; - - // 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() . self::convertToClassName($controllerName) . 'Controller'; - - // ... and set it - $this->setClassName($className); - } else { - // No news at main controller or non-news controller - $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 controller 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 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; - - // Is a controller set? - if (empty($controllerName)) { - // Then thrown an exception here - throw new EmptyVariableException(array($this, 'controllerName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING); - } // END - if - - // Create class name - $className = $this->getCapitalizedClassPrefix() . self::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) { - // Is this class already loaded? - if (class_exists($this->getClassName())) { - // This class does exist. :-) - $isValid = TRUE; - } elseif ($this->getClassName() != $this->getCapitalizedClassPrefix() . 'DefaultNewsController') { - // Set default controller - $this->setClassName($this->getCapitalizedClassPrefix() . 'DefaultNewsController'); - } else { - // All is tried, give it up here - throw new DefaultControllerException($this, self::EXCEPTION_DEFAULT_CONTROLLER_GONE); - } - } // END - while - - // Return the result - return $isValid; - } - - /** - * Resolves the default controller of the given controller - * - * @return $controllerInstance A controller instance for the default - * controller - * @throws InvalidControllerInstanceException Thrown if $controllerInstance - * is invalid - */ - public function resolveController () { - // Init variables - $controllerName = ''; - $controllerInstance = NULL; - - // Get the controller name - $controllerName = $this->getControllerName(); - - // Get the controller - $controllerInstance = $this->loadController($controllerName); - - // And validate it - if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) { - // This controller 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] -?>