+++ /dev/null
-<?php
-// Own namespace
-namespace CoreFramework\Resolver\Controller;
-
-// Import framework stuff
-use CoreFramework\Controller\DefaultControllerException;
-use CoreFramework\Controller\Controller;
-use CoreFramework\Factory\ObjectFactory;
-use CoreFramework\Generic\EmptyVariableException;
-use CoreFramework\Resolver\BaseResolver;
-use CoreFramework\Resolver\Controller\ControllerResolver;
-/**
- * A generic controller resolver class
- *
- * @author Roland Haeder <webmaster@shipsimu.org>
- * @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 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 <http://www.gnu.org/licenses/>.
- */
-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;
-
- // Create full class name
- $className = sprintf(
- '%s\%sDefaultNewsController',
- $this->getNamespace(),
- $this->getCapitalizedClassPrefix()
- );
-
- // Default controller
- $this->setClassName($className);
-
- // Generate the class name
- //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BEFORE: controller=' . $controllerName);
- if ($controllerName != $defaultController) {
- // Create controller class name
- $className = sprintf(
- '%s\%s%sController',
- $namespace,
- $this->getCapitalizedClassPrefix(),
- self::convertToClassName($controllerName)
- );
-
- // ... and set it
- $this->setClassName($className);
- } else {
- // No news at main controller or non-news controller
- $this->setClassName($className);
- }
- //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->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 $namespace Namespace to look in, no trailing backslash
- * @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
- */
- protected function isControllerValid ($namespace, $controllerName) {
- // By default nothing shall be valid
- $isValid = FALSE;
-
- // Is namespace and controller name set?
- if (empty($namespace)) {
- // Then thrown an exception here
- throw new EmptyVariableException(array($this, 'namespace'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
- } elseif (empty($controllerName)) {
- // Then thrown an exception here
- throw new EmptyVariableException(array($this, 'controllerName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
- } // END - if
-
- // Create class name
- $className = sprintf(
- '%s\%sController',
- $namespace,
- $this->getCapitalizedClassPrefix() . self::convertToClassName($controllerName)
- );
- $newsControllerName = sprintf(
- '%s\%sDefaultNewsController',
- $namespace,
- $this->getCapitalizedClassPrefix()
- );
-
- // Debug message
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('className=%s', $className));
-
- // 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() != $newsControllerName) {
- // Set default controller
- $this->setClassName($newsControllerName);
- } 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 namespace and 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;
- }
-
-}
projects / core.git / blobdiff