X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fresponse%2Fimage%2Fclass_ImageResponse.php;h=0a8e92c7cdb0abe62273053be4171402e8f4648f;hp=63c3dfcf2195113042819617290e81ff769191e9;hb=c3021952494266e05bfa9046baf9bcd11bfe7d13;hpb=a3fa89c7cbc54491fc74f13db0927d14acf550c8 diff --git a/inc/classes/main/response/image/class_ImageResponse.php b/inc/classes/main/response/image/class_ImageResponse.php index 63c3dfcf..0a8e92c7 100644 --- a/inc/classes/main/response/image/class_ImageResponse.php +++ b/inc/classes/main/response/image/class_ImageResponse.php @@ -2,11 +2,11 @@ /** * A class for an image response on an HTTP request * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 @@ -38,18 +38,18 @@ class ImageResponse extends BaseResponse implements Responseable { /** * 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; @@ -58,22 +58,22 @@ class ImageResponse extends BaseResponse implements Responseable { /** * 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(); // Set new template engine - $cfg->setConfigEntry('web_template_class' , $cfg->getConfigEntry('image_template_class')); + $cfg->setConfigEntry('html_template_class' , $cfg->getConfigEntry('image_template_class')); $cfg->setConfigEntry('raw_template_extension' , '.img'); $cfg->setConfigEntry('code_template_extension', '.xml'); $cfg->setConfigEntry('tpl_base_path' , 'templates/images/'); $cfg->setConfigEntry('code_template_type' , 'image'); // Get a prepared instance - $this->setTemplateInstance($this->prepareTemplateInstance($appInstance)); + $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance)); } /** @@ -90,7 +90,7 @@ class ImageResponse extends BaseResponse implements Responseable { * @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 @@ -98,7 +98,7 @@ class ImageResponse extends BaseResponse implements Responseable { } // 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 @@ -120,8 +120,8 @@ class ImageResponse extends BaseResponse implements Responseable { // 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; @@ -146,7 +146,7 @@ class ImageResponse extends BaseResponse implements Responseable { $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); @@ -179,11 +179,11 @@ class ImageResponse extends BaseResponse implements Responseable { /** * 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(); @@ -210,7 +210,7 @@ class ImageResponse extends BaseResponse implements Responseable { // Is the cookie there? if (isset($_COOKIE[$cookieName])) { // Then expire it with 20 minutes past - $this->addCookie($cookieName, '', false, (time() - 1200)); + $this->addCookie($cookieName, '', FALSE, (time() - 1200)); // Remove it from array unset($_COOKIE[$cookieName]); @@ -227,7 +227,7 @@ class ImageResponse extends BaseResponse implements Responseable { // Only update existing cookies if (isset($_COOKIE[$cookieName])) { // Update the cookie - $this->addCookie($cookieName, $_COOKIE[$cookieName], false); + $this->addCookie($cookieName, $_COOKIE[$cookieName], FALSE); } // END - if }