Closing bracket fixed

[shipsimu.git] / inc / classes / main / response / class_HttpResponse.php

diff --git a/inc/classes/main/response/class_HttpResponse.php b/inc/classes/main/response/class_HttpResponse.php
index f4a3d50e3e16166be1ee05a2724e204d35396e37..46979c7fa17227f1435ca1314ba3c572214b569f 100644 (file)
--- a/inc/classes/main/response/class_HttpResponse.php
+++ b/inc/classes/main/response/class_HttpResponse.php
@@ -148,7 +148,7 @@ class HttpResponse extends BaseFrameworkSystem implements Responseable {
        /**
         * Flushs the cached HTTP response to the outer world
         *
-        * @param       $foce   Wether we shall force the output or abort if headers are
+        * @param       $force  Wether we shall force the output or abort if headers are
         *                                      already sent with an exception
         * @return      void
         * @throws      ResponseHeadersAlreadySentException             Thrown if headers are
@@ -243,10 +243,15 @@ class HttpResponse extends BaseFrameworkSystem implements Responseable {
         * @param       $cookieName             Cookie's name
         * @param       $cookieValue    Value to store in the cookie
         * @param       $encrypted              Do some extra encryption on the value
+        * @param       $expires                Timestamp of expiration (default: configured)
         * @return      void
         * @throws      ResponseHeadersAlreadySentException             If headers are already sent
+        * @todo        Encryption of cookie data not yet supported.
+        * @todo        Why are these parameters conflicting?
+        * @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) {
+       public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = null) {
                // Are headers already sent?
                if (headers_sent()) {
                        // Throw an exception here
@@ -255,27 +260,26 @@ class HttpResponse extends BaseFrameworkSystem implements Responseable {
 
                // Shall we encrypt the cookie?
                if ($encrypted === true) {
-                       // @TODO Encryption of cookie data not yet supported
                } // END - if
 
                // For slow browsers set the cookie array element first
                $_COOKIE[$cookieName] = $cookieValue;
 
-               // Get a config entries
-               $expires = (time() + $this->getConfigInstance()->readConfig('cookie_expire'));
+               // 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);
-               // TODO Why are these parameters conflicting?
                //, $path, $domain, (isset($_SERVER['HTTPS']))
                return;
-               // TODO This will send only one cookie out, the first one.
 
                // Now construct the full header
                $cookieString = $cookieName . "=" . $cookieValue . "; ";
                $cookieString .= "expires=" . date("D, d-F-Y H:i:s", $expires) . " GMT";
-               // TODO Why are these parameters conflicting?
                // $cookieString .= "; path=".$path."; domain=".$domain;
 
                // Set the cookie as a header
@@ -324,6 +328,37 @@ class HttpResponse extends BaseFrameworkSystem implements Responseable {
                // All done here...
                exit();
        }
+
+       /**
+        * Expires the given cookie if it is set
+        *
+        * @param       $cookieName             Cookie to expire
+        * @return      void
+        */
+       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
+       }
+
+       /**
+        * Refreshs a given cookie. This will make the cookie live longer
+        *
+        * @param       $cookieName             Cookie to refresh
+        * @return      void
+        */
+       public function refreshCookie ($cookieName) {
+               // Only update existing cookies
+               if (isset($_COOKIE[$cookieName])) {
+                       // Update the cookie
+                       $this->addCookie($cookieName, $_COOKIE[$cookieName], false);
+               } // END - if
+       }
 }
 
 // [EOF]