class_WebControllerResolver.php

Go to the documentation of this file.

<?php
class WebControllerResolver extends BaseControllerResolver implements ControllerResolver {
        private $lastControllerName = "";

        private $lastControllerInstance = null;

        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);

                // Set prefix to "Web"
                $this->setControllerPrefix("Web");
        }

        public final static function createWebControllerResolver ($controllerName, ManageableApplication $appInstance) {
                // Create the new instance
                $resolverInstance = new WebControllerResolver();

                // Is the variable $controllerName set and the command is valid?
                if (empty($controllerName)) {
                        // Then thrown an exception here
                        throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
                } elseif ($resolverInstance->isControllerValid($controllerName) === false) {
                        // Invalid command found
                        throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
                }

                // Set the application instance
                $resolverInstance->setApplicationInstance($appInstance);

                // Set command name
                $resolverInstance->setControllerName($controllerName);

                // Return the prepared instance
                return $resolverInstance;
        }

        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->lastControllerInstance = $controllerInstance;

                // Return the maybe resolved instance
                return $controllerInstance;
        }

        private function loadController ($controllerName) {
                // Cache default command
                $defaultController = $this->getConfigInstance()->readConfig('default_web_command');

                // Init controller instance
                $controllerInstance = null;

                // Default controller
                $this->setClassName('WebDefaultController');

                // Generate the class name
                //* DEBUG: */ echo __METHOD__.": Controller=".$controllerName;
                if ($controllerName != $defaultController) {
                        // Create controller class name
                        $this->setClassName(sprintf("Web%sController",
                                $this->convertToClassName($controllerName)
                        ));
                } elseif ($this->getConfigInstance()->readConfig('page_with_news') == $this->getApplicationInstance()->getRequestInstance()->getRequestElement('page')) {
                        // Yes, display news in home then set default controller with news
                        $this->setClassName('WebDefaultNewsController');
                } else {
                        // No news at home page or non-news page
                        $this->setClassName('WebDefaultController');
                }
                //* 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("web_cmd_%s_resolver_class", 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
                        $resolverConfigEntry = "web_cmd_resolver_class";
                }

                // Initiate the resolver and controller
                $resolverInstance = ObjectFactory::createObjectByConfiguredName($resolverConfigEntry, array($controllerName, $this->getApplicationInstance()));
                $controllerInstance = ObjectFactory::createObjectByName($this->getClassName(), array($resolverInstance));

                // Remove resolver (we don't need it anymore)
                unset($resolverInstance);

                // Return the result
                return $controllerInstance;
        }
}

// [EOF]
?>