class_HttpResponse.php

Go to the documentation of this file.

<?php
class HttpResponse extends BaseResponse implements Responseable {
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
        }

        public final static function createHttpResponse (ManageableApplication $appInstance) {
                // Get a new instance
                $responseInstance = new HttpResponse();

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

                // Initialize the template engine here
                $responseInstance->initTemplateEngine($appInstance);

                // Return the prepared instance
                return $responseInstance;
        }

        public final function initTemplateEngine (ManageableApplication $appInstance) {
                $this->setTemplateInstance($this->prepareTemplateInstance($appInstance));
        }

        public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = null) {
                //* DEBUG: */ echo $cookieName."=".$cookieValue."<br />\n";
                // Are headers already sent?
                if (headers_sent()) {
                        // Throw an exception here
                        //* DEBUG: */ return;
                        throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
                } // END - if

                // Shall we encrypt the cookie?
                if ($encrypted === true) {
                } // END - if

                // For slow browsers set the cookie array element first
                $_COOKIE[$cookieName] = $cookieValue;

                // Get all config entries
                if (is_null($expires)) {
                        $expires = (time() + $this->getConfigInstance()->readConfig('cookie_expire'));
                } // END - if

                $path = $this->getConfigInstance()->readConfig('cookie_path');
                $domain = $this->getConfigInstance()->readConfig('cookie_domain');

                setcookie($cookieName, $cookieValue, $expires);
                //, $path, $domain, (isset($_SERVER['HTTPS']))
                return;

                // Now construct the full header
                $cookieString = $cookieName . "=" . $cookieValue . "; ";
                $cookieString .= "expires=" . date("D, d-F-Y H:i:s", $expires) . " GMT";
                // $cookieString .= "; path=".$path."; domain=".$domain;

                // Set the cookie as a header
                $this->cookies[$cookieName] = $cookieString;
        }

        public function redirectToConfiguredUrl ($configEntry) {
                // Is the header not yet sent?
                if (headers_sent()) {
                        // Throw an exception here
                        throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
                } // END - if

                // Assign application data
                $this->getTemplateInstance()->assignApplicationData($this->getApplicationInstance());

                // Get the url from config
                $url = $this->getConfigInstance()->readConfig($configEntry);

                // Compile the URL
                $url = $this->getTemplateInstance()->compileRawCode($url);

                // Do we have a "http" in front of the URL?
                if (substr(strtolower($url), 0, 4) != "http") {
                        // Is there a / in front of the relative URL?
                        if (substr($url, 0, 1) == "/") $url = substr($url, 1);

                        // No, then extend it with our base URL
                        $url = $this->getConfigInstance()->readConfig('base_url') . "/" . $url;
                } // END - if

                // Add redirect header
                $this->addHeader("Location", $url);

                // Set correct response status
                $this->setResponseStatus("301 Moved Permanently");

                // Clear the body
                $this->setResponseBody("");

                // Flush the result
                $this->flushBuffer();

                // All done here...
                exit();
        }

        public function expireCookie ($cookieName) {
                // Is the cookie there?
                if (isset($_COOKIE[$cookieName])) {
                        // Then expire it with 20 minutes past
                        $this->addCookie($cookieName, "", false, (time() - 1200));

                        // Remove it from array
                        unset($_COOKIE[$cookieName]);
                } // END - if
        }

        public function refreshCookie ($cookieName) {
                // Only update existing cookies
                if (isset($_COOKIE[$cookieName])) {
                        // Update the cookie
                        $this->addCookie($cookieName, $_COOKIE[$cookieName], false);
                } // END - if
        }

        public function getDefaultCommand () {
                $defaultCommand = $this->getConfigInstance()->readConfig('default_web_command');
                return $defaultCommand;
        }
}

// [EOF]
?>