Made lower to upper case:

[core.git] / inc / classes / interfaces / response / class_Responseable.php

diff --git a/inc/classes/interfaces/response/class_Responseable.php b/inc/classes/interfaces/response/class_Responseable.php
index cc9cc6906452f90c69390735093c7dee1f31fdd0..46a511484d5b4a4ce73a7c7007ef88a03858a88f 100644 (file)
--- a/inc/classes/interfaces/response/class_Responseable.php
+++ b/inc/classes/interfaces/response/class_Responseable.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -31,7 +31,11 @@ interface Responseable extends FrameworkInterface {
        function setResponseStatus ($status);
 
        /**
-        * Add header element
+        * Adds a header to the response. This method "wraps" the direct header()
+        * function call and so it can be done "generic". E.g. if a local
+        * application like my hub does not support redirects, this method can be
+        * kept empty or it can be done something else which would not be possible
+        * with a direct header() call.
         *
         * @param       $name   Name of header element
         * @param       $value  Value of header element
@@ -50,13 +54,13 @@ interface Responseable extends FrameworkInterface {
        /**
         * Flushs the cached HTTP response to the outer world
         *
-        * @param       $force  Wether we shall force the output or abort if headers are
+        * @param       $force  Whether we shall force the output or abort if headers are
         *                                      already sent with an exception
         * @return      void
         * @throws      ResponseHeadersAlreadySentException             Thrown if headers are
         *                                                                                                      already sent
         */
-       function flushBuffer ($force = false);
+       function flushBuffer ($force = FALSE);
 
        /**
         * Adds a fatal message id to the response. The added messages can then be
@@ -76,11 +80,12 @@ interface Responseable extends FrameworkInterface {
         * @return      void
         * @throws      ResponseHeadersAlreadySentException             If headers are already sent
         */
-       function addCookie ($cookieName, $cookieValue, $encrypted = false);
+       function addCookie ($cookieName, $cookieValue, $encrypted = FALSE);
 
        /**
         * Redirect to a configured URL. The URL can be absolute or relative. In
-        * case of relative URL it will be extended automatically.
+        * case of relative URL it will be extended automatically with the
+        * 'base_url' from configuration.
         *
         * @param       $configEntry    The configuration entry which holds our URL
         * @return      void
@@ -105,5 +110,5 @@ interface Responseable extends FrameworkInterface {
        function refreshCookie ($cookieName);
 }
 
-//
+// [EOF]
 ?>