resolveController() was everywhere the same, still you can overwrite it with

[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 937db3532123dd9946ea30d5ae4322c0d240f7a2..b9ae868f6fe732367fb1ceb1239427a3924bd3c2 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@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 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.shipsimu.org
  *
@@ -22,11 +22,6 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class BaseControllerResolver extends BaseResolver {
-       /**
-        * Validated controller name
-        */
-       private $controllerName = '';
-
        /**
         * Protected constructor
         *
@@ -38,25 +33,6 @@ class BaseControllerResolver extends BaseResolver {
                parent::__construct($className);
        }
 
-       /**
-        * 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
@@ -75,19 +51,19 @@ class BaseControllerResolver extends BaseResolver {
                $controllerInstance = NULL;
 
                // Default controller
-               $this->setClassName($this->getClassPrefix() . 'DefaultNewsController');
+               $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->getClassPrefix() . $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->getClassPrefix() . 'DefaultNewsController');
+                       $this->setClassName($this->getCapitalizedClassPrefix() . 'DefaultNewsController');
                }
                //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('AFTER: controller=' . $this->getClassName());
 
@@ -101,7 +77,7 @@ class BaseControllerResolver extends BaseResolver {
                $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));
+               $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);
@@ -142,7 +118,7 @@ class BaseControllerResolver extends BaseResolver {
                } // END - if
 
                // Create class name
-               $className = $this->getClassPrefix() . $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);
@@ -153,9 +129,9 @@ class BaseControllerResolver extends BaseResolver {
                        if (class_exists($this->getClassName())) {
                                // This class does exist. :-)
                                $isValid = TRUE;
-                       } elseif ($this->getClassName() != $this->getClassPrefix() . 'DefaultNewsController') {
+                       } elseif ($this->getClassName() != $this->getCapitalizedClassPrefix() . 'DefaultNewsController') {
                                // Set default controller
-                               $this->setClassName($this->getClassPrefix() . 'DefaultNewsController');
+                               $this->setClassName($this->getCapitalizedClassPrefix() . 'DefaultNewsController');
                        } else {
                                // All is tried, give it up here
                                throw new DefaultControllerException($this, self::EXCEPTION_DEFAULT_CONTROLLER_GONE);
@@ -165,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]