*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
+ * @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
*
/**
* 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 static final function createImageResponse (ManageableApplication $appInstance) {
+ public static final function createImageResponse (ManageableApplication $applicationInstance) {
// Get a new instance
$responseInstance = new ImageResponse();
// Set the application instance
- $responseInstance->setApplicationInstance($appInstance);
+ $responseInstance->setApplicationInstance($applicationInstance);
// Initialize the template engine here
- $responseInstance->initTemplateEngine($appInstance);
+ $responseInstance->initTemplateEngine($applicationInstance);
// Return the prepared instance
return $responseInstance;
/**
* 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) {
+ public final function initTemplateEngine (ManageableApplication $applicationInstance) {
// Get config instance
$cfg = $this->getConfigInstance();
$cfg->setConfigEntry('code_template_type' , 'image');
// Get a prepared instance
- $this->setTemplateInstance($this->prepareTemplateInstance($appInstance));
+ $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
}
/**
* @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) {
// Are headers already sent?
if (headers_sent()) {
// Throw an exception here
} // 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
// Now construct the full header
$cookieString = $cookieName . '=' . $cookieValue . '; ';
- $cookieString .= "expires=" . date("D, d-F-Y H:i:s", $expires) . " GMT";
- // $cookieString .= "; path=".$path."; domain=".$domain;
+ $cookieString .= 'expires=' . date('D, d-F-Y H:i:s', $expires) . ' GMT';
+ // TODO Why is this not always working? $cookieString .= '; path=' . $path . '; domain=' . $domain;
// Set the cookie as a header
$this->cookies[$cookieName] = $cookieString;
$this->getTemplateInstance()->assignApplicationData($this->getApplicationInstance());
// Get the url from config
- $url = $this->getConfigInstance()->getConfigEntry($configEntry . "_url");
+ $url = $this->getConfigInstance()->getConfigEntry($configEntry . '_url');
// Compile the URL
$url = $this->getTemplateInstance()->compileRawCode($url);
/**
* 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
*/
- public function flushBuffer ($force = false) {
+ public function flushBuffer ($force = FALSE) {
// Finish the image
$this->getImageInstance()->finishImage();