loadController() is now more generic (TODO: check that all other apps works)

[core.git] / inc / classes / main / resolver / controller / class_BaseControllerResolver.php

diff --git a/inc/classes/main/resolver/controller/class_BaseControllerResolver.php b/inc/classes/main/resolver/controller/class_BaseControllerResolver.php
index a667fe6cf2724fb5d52a5a2fbda87db5b8f2e3e9..ece1f26d8b64679c905dcf762235a46374ec4336 100644 (file)
--- a/inc/classes/main/resolver/controller/class_BaseControllerResolver.php
+++ b/inc/classes/main/resolver/controller/class_BaseControllerResolver.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -25,12 +25,12 @@ class BaseControllerResolver extends BaseResolver {
        /**
         * Prefix for local, remote or other resolver
         */
-       private $controllerPrefix = "";
+       private $controllerPrefix = '';
 
        /**
         * Validated controller name
         */
-       private $controllerName = "";
+       private $controllerName = '';
 
        /**
         * Protected constructor
@@ -72,6 +72,79 @@ class BaseControllerResolver extends BaseResolver {
                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.
+        *
+        * @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()->readConfig('default_' . strtolower($this->getControllerPrefix()) . '_command');
+
+               // Init controller instance
+               $controllerInstance = null;
+
+               // Default controller
+               $this->setClassName($this->getControllerPrefix() . 'DefaultNewsController');
+
+               // Generate the class name
+               //* DEBUG: */ echo __METHOD__.": Controller=".$controllerName;
+               if ($controllerName != $defaultController) {
+                       // Create controller class name
+                       $className = $this->getControllerPrefix() . '' . $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');
+               }
+               //* DEBUG: */ echo ", controller=".$this->getClassName()."<br />\n";
+
+               // 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... ;-)
+               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 = $this->getControllerPrefix() . '_cmd_resolver_class';
+               }
+
+               // 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
         *
@@ -90,11 +163,11 @@ class BaseControllerResolver extends BaseResolver {
                        throw new EmptyVariableException(array($this, 'controllerName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
                } // END - if
 
+               // Create class name
+               $className = $this->controllerPrefix . $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) {
@@ -102,15 +175,9 @@ class BaseControllerResolver extends BaseResolver {
                        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');
-                               }
+                       } elseif ($this->getClassName() != $this->controllerPrefix.'DefaultNewsController') {
+                               // Set default controller
+                               $this->setClassName($this->controllerPrefix . 'DefaultNewsController');
                        } else {
                                // All is tried, give it up here
                                throw new DefaultControllerException($this, self::EXCEPTION_DEFAULT_CONTROLLER_GONE);