/**
* An interface for responses
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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
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
/**
* 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
* @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
function refreshCookie ($cookieName);
}
-//
+// [EOF]
?>