Introduced initWebOutputInstance() which will initialize a web output instance.

[core.git] / inc / classes / main / response / http / class_HttpResponse.php

diff --git a/inc/classes/main/response/http/class_HttpResponse.php b/inc/classes/main/response/http/class_HttpResponse.php
index 46f42d6f5fa62cf95f921b5edce300606ae35886..d26b33bc21791af0216c7680db30931c5f2aa0c6 100644 (file)
--- a/inc/classes/main/response/http/class_HttpResponse.php
+++ b/inc/classes/main/response/http/class_HttpResponse.php
@@ -2,11 +2,11 @@
 /**
  * A class for an HTTP response on an HTTP request
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -38,18 +38,21 @@ class HttpResponse extends BaseResponse implements Responseable {
        /**
         * Creates an object of this class
         *
-        * @param       $appInstance            An instance of a manageable application
-        * @return      $responseInstance       A prepared instance of this class
+        * @param       $applicationInstance    An instance of a manageable application
+        * @return      $responseInstance               A prepared instance of this class
         */
-       public final static function createHttpResponse (ManageableApplication $appInstance) {
+       public static final function createHttpResponse (ManageableApplication $applicationInstance) {
                // Get a new instance
                $responseInstance = new HttpResponse();
 
                // Set the application instance
-               $responseInstance->setApplicationInstance($appInstance);
+               $responseInstance->setApplicationInstance($applicationInstance);
 
                // Initialize the template engine here
-               $responseInstance->initTemplateEngine($appInstance);
+               $responseInstance->initTemplateEngine($applicationInstance);
+
+               // Init web output instance
+               $responseInstance->initWebOutputInstance();
 
                // Return the prepared instance
                return $responseInstance;
@@ -58,11 +61,11 @@ class HttpResponse extends BaseResponse implements Responseable {
        /**
         * Initializes the template engine instance
         *
-        * @param       $appInstance    An instance of a manageable application
+        * @param       $applicationInstance    An instance of a manageable application
         * @return      void
         */
-       public final function initTemplateEngine (ManageableApplication $appInstance) {
-               $this->setTemplateInstance($this->prepareTemplateInstance($appInstance));
+       public final function initTemplateEngine (ManageableApplication $applicationInstance) {
+               $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
        }
 
        /**
@@ -79,7 +82,7 @@ class HttpResponse extends BaseResponse implements Responseable {
         * @todo        If the return statement is removed and setcookie() commented out,
         * @todo        this will send only one cookie out, the first one.
         */
-       public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = null) {
+       public function addCookie ($cookieName, $cookieValue, $encrypted = FALSE, $expires = NULL) {
                //* DEBUG: */ echo $cookieName.'='.$cookieValue."<br />\n";
                // Are headers already sent?
                if (headers_sent()) {
@@ -89,7 +92,9 @@ class HttpResponse extends BaseResponse implements Responseable {
                } // END - if
 
                // Shall we encrypt the cookie?
-               if ($encrypted === true) {
+               if ($encrypted === TRUE) {
+                       // Unsupported at the moment
+                       $this->partialStub('Encryption is unsupported at the moment.');
                } // END - if
 
                // For slow browsers set the cookie array element first
@@ -97,11 +102,11 @@ class HttpResponse extends BaseResponse implements Responseable {
 
                // Get all config entries
                if (is_null($expires)) {
-                       $expires = (time() + $this->getConfigInstance()->readConfig('cookie_expire'));
+                       $expires = (time() + $this->getConfigInstance()->getConfigEntry('cookie_expire'));
                } // END - if
 
-               $path = $this->getConfigInstance()->readConfig('cookie_path');
-               $domain = $this->getConfigInstance()->readConfig('cookie_domain');
+               $path = $this->getConfigInstance()->getConfigEntry('cookie_path');
+               $domain = $this->getConfigInstance()->getConfigEntry('cookie_domain');
 
                setcookie($cookieName, $cookieValue, $expires);
                //, $path, $domain, (isset($_SERVER['HTTPS']))
@@ -109,7 +114,7 @@ class HttpResponse extends BaseResponse implements Responseable {
 
                // Now construct the full header
                $cookieString = $cookieName . '=' . $cookieValue . '; ';
-               $cookieString .= "expires=" . date("D, d-F-Y H:i:s", $expires) . " GMT";
+               $cookieString .= 'expires=' . date('D, d-F-Y H:i:s', $expires) . ' GMT';
                // $cookieString .= "; path=".$path."; domain=".$domain;
 
                // Set the cookie as a header
@@ -135,7 +140,7 @@ class HttpResponse extends BaseResponse implements Responseable {
                $this->getTemplateInstance()->assignApplicationData($this->getApplicationInstance());
 
                // Get the url from config
-               $url = $this->getConfigInstance()->readConfig($configEntry . "_url");
+               $url = $this->getConfigInstance()->getConfigEntry($configEntry . '_url');
 
                // Compile the URL
                $url = $this->getTemplateInstance()->compileRawCode($url);
@@ -146,11 +151,11 @@ class HttpResponse extends BaseResponse implements Responseable {
                        if (substr($url, 0, 1) == '/') $url = substr($url, 1);
 
                        // No, then extend it with our base URL
-                       $url = $this->getConfigInstance()->readConfig('base_url') . '/' . $url;
+                       $url = $this->getConfigInstance()->getConfigEntry('base_url') . '/' . $url;
                } // END - if
 
                // Add redirect header
-               $this->addHeader('Location', $url);
+               $this->addHeader('Location', str_replace('&amp;', '&', $url));
 
                // Set correct response status
                $this->setResponseStatus('301 Moved Permanently');
@@ -175,7 +180,7 @@ class HttpResponse extends BaseResponse implements Responseable {
                // Is the cookie there?
                if (isset($_COOKIE[$cookieName])) {
                        // Then expire it with 20 minutes past
-                       $this->addCookie($cookieName, '', false, (time() - 1200));
+                       $this->addCookie($cookieName, '', FALSE, (time() - 1200));
 
                        // Remove it from array
                        unset($_COOKIE[$cookieName]);
@@ -192,7 +197,7 @@ class HttpResponse extends BaseResponse implements Responseable {
                // Only update existing cookies
                if (isset($_COOKIE[$cookieName])) {
                        // Update the cookie
-                       $this->addCookie($cookieName, $_COOKIE[$cookieName], false);
+                       $this->addCookie($cookieName, $_COOKIE[$cookieName], FALSE);
                } // END - if
        }
 
@@ -202,7 +207,7 @@ class HttpResponse extends BaseResponse implements Responseable {
         * @return      $defaultCommand         Default command for this response
         */
        public function getDefaultCommand () {
-               $defaultCommand = $this->getConfigInstance()->readConfig('default_web_command');
+               $defaultCommand = $this->getConfigInstance()->getConfigEntry('default_web_command');
                return $defaultCommand;
        }
 }