class_WebLoginAreaCommand.php

Go to the documentation of this file.

<?php
class WebLoginAreaCommand extends BaseCommand implements Commandable {
        private $actionName = "";

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

        public final static function createWebLoginAreaCommand (CommandResolver $resolverInstance) {
                // Get new instance
                $commandInstance = new WebLoginAreaCommand();

                // Set the application instance
                $commandInstance->setResolverInstance($resolverInstance);

                // Load general data like user status and such
                $commandInstance->prepareCommand();

                // Return the prepared instance
                return $commandInstance;
        }

        protected function prepareCommand () {
        }

        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                // Get the action instance from registry
                $actionInstance = Registry::getRegistry()->getInstance('action');

                // Do we have an action here?
                if ($actionInstance instanceof PerformableAction) {
                        // Execute the action (shall not output anything, see below why)
                        $actionInstance->execute($requestInstance, $responseInstance);
                } // END - if

                // Get the application instance
                $appInstance = $this->getResolverInstance()->getApplicationInstance();

                // Prepare a template instance
                $templateInstance = $this->prepareTemplateInstance($appInstance);

                // Assign base URL
                $templateInstance->assignConfigVariable('base_url');

                // Assign all the application's data with template variables
                $templateInstance->assignApplicationData($appInstance);

                // Load the master template
                $masterTemplate = $appInstance->getMasterTemplate();

                // Load header template
                $templateInstance->loadCodeTemplate('header');

                // Compile and assign it with a variable
                $templateInstance->compileTemplate();
                $templateInstance->assignTemplateWithVariable('header', 'header');

                // Load footer template
                $templateInstance->loadCodeTemplate('footer');

                // Compile and assign it with a variable
                $templateInstance->compileTemplate();
                $templateInstance->assignTemplateWithVariable('footer', 'footer');

                // Load the matching template
                $templateInstance->loadCodeTemplate('action_' . $this->actionName);

                // Assign the template with the master template as a content ... ;)
                $templateInstance->compileTemplate();
                $templateInstance->assignTemplateWithVariable('action_' . $this->actionName, 'login_content');

                // Load main template
                $templateInstance->loadCodeTemplate('login_main');

                // Assign the main template with the master template as a content ... ;)
                $templateInstance->compileTemplate();
                $templateInstance->assignTemplateWithVariable('login_main', 'content');

                // Load the master template
                $templateInstance->loadCodeTemplate($masterTemplate);

                // Set title
                $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage($this->actionName . '_title'));

                // ... and all variables. This should be merged together in a pattern
                // to make things easier. A cache mechanism should be added between
                // these two calls to cache compiled templates.
                $templateInstance->compileVariables();

                // Get the content back from the template engine and put it in response class
                $templateInstance->transferToResponse($responseInstance);
        }

        public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
                // Default is no action
                $actionInstance = null;

                // Get registry
                $registryInstance = Registry::getRegistry();

                // Get our application instance from the registry
                $appInstance = $registryInstance->getInstance('application');

                // Default action is the one from configuration
                $this->actionName = sprintf("%s_login_%s",
                        str_replace("-", "_", $appInstance->getAppShortName()),
                        $this->getConfigInstance()->readConfig('login_default_action')
                );

                // Get "action" from request
                $actReq = $requestInstance->getRequestElement('action');

                // Do we have a "action" parameter set?
                if ((is_string($actReq)) && (!empty($actReq))) {
                        // Then use it with prefix
                        $this->actionName = sprintf("%s_login_%s",
                                str_replace("-", "_", $appInstance->getAppShortName()),
                                $actReq
                        );
                } // END - if

                // Get application instance
                $applicationInstance = $this->getResolverInstance()->getApplicationInstance();

                // Get a resolver
                $actionResolver = WebActionResolver::createWebActionResolver($this->actionName, $applicationInstance);

                // Resolve the action
                $actionInstance = $actionResolver->resolveAction();

                // Add more action-specific filters
                $actionInstance->addExtraFilters($controllerInstance, $requestInstance);

                // Remember this action in registry
                Registry::getRegistry()->addInstance('action', $actionInstance);
        }
}

// [EOF]
?>