Comments extended for better inline documentation
authorRoland Häder <roland@mxchange.org>
Tue, 10 Mar 2009 22:54:28 +0000 (22:54 +0000)
committerRoland Häder <roland@mxchange.org>
Tue, 10 Mar 2009 22:54:28 +0000 (22:54 +0000)
inc/classes/interfaces/response/class_Responseable.php

index cc9cc69..9830a98 100644 (file)
@@ -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
@@ -80,7 +84,8 @@ interface Responseable extends FrameworkInterface {
 
        /**
         * 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