class_BaseResponse.php

Go to the documentation of this file.

<?php
class BaseResponse extends BaseFrameworkSystem {
        private $responseStatus = "200 OK";

        private $responseHeaders = array();

        private $cookies = array();

        private $responseBody = "";

        private $templateInstance = null;

        private $fatalMessages = array();

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

                // Clean up a little
                $this->removeNumberFormaters();
                $this->removeSystemArray();
        }

        public final function setResponseStatus ($status) {
                $this->responseStatus = (string) $status;
        }

        public final function addHeader ($name, $value) {
                $this->responseHeaders[$name] = $value;
        }

        public final function resetResponseHeaders () {
                $this->responseHeaders = array();
        }

        public final function writeToBody ($output) {
                $this->responseBody .= $output;
        }

        public final function setResponseBody ($output) {
                $this->responseBody = $output;
        }

        public final function addFatalMessage ($messageId) {
                // Adds the resolved message id to the fatal message list
                $this->fatalMessages[] = $this->getApplicationInstance()->getLanguageInstance()->getMessage($messageId);
        }

        public final function addFatalMessagePlain ($message) {
                // Adds the resolved message id to the fatal message list
                $this->fatalMessages[] = $message;
        }

        public function flushBuffer ($force = false) {
                if ((headers_sent()) && ($force === false)) {
                        // Headers are already sent!
                        throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
                } elseif (!headers_sent()) {
                        // Send headers out
                        header("HTTP/1.1 {$this->responseStatus}");

                        // Used later
                        $now = gmdate('D, d M Y H:i:s') . ' GMT';

                        // General header for no caching
                        $this->addHeader('Expired', $now); // RFC2616 - Section 14.21
                        $this->addHeader('Last-Modified', $now);
                        $this->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
                        $this->addHeader('Pragma', 'no-cache'); // HTTP/1.0

                        // Define the charset to be used
                        //$this->addHeader('Content-type:', sprintf("text/html; charset=%s", $this->getConfigInstance()->readConfig('header_charset')));

                        // Send all headers
                        foreach ($this->responseHeaders as $name => $value) {
                                header("{$name}: {$value}");
                                //* DEBUG: */ echo "{$name}: {$value}<br />\n";
                        } // END - foreach

                        // Send cookies out?
                        if (count($this->cookies) > 0) {
                                // Send all cookies
                                $cookieString = implode(" ", $this->cookies);
                                header("Set-Cookie: {$cookieString}");

                                // Remove them all
                                $this->cookies = array();
                        } // END - if
                }

                // Are there some error messages?
                if (count($this->fatalMessages) == 0) {
                        // Flush the output to the world
                        $this->getWebOutputInstance()->output($this->responseBody);
                } else {
                        // Display all error messages
                        $this->getApplicationInstance()->handleFatalMessages($this->fatalMessages);

                        // Send the error messages out to the world
                        $this->getWebOutputInstance()->output($this->responseBody);
                }

                // Clear response header and body
                $this->setResponseBody("");
                $this->resetResponseHeaders();
        }
}

// [EOF]
?>