X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fresponse%2Fimage%2Fclass_ImageResponse.php;h=3cd50146d77d4307dca372598466260362d2da48;hp=27fac282900e22c0475b4c6a87c60e6f1d16ca66;hb=eb23105bef52d3bf706abe6f225170d8e143339e;hpb=d73560a7ae364cce1365cc412c252ea60e33bf09 diff --git a/inc/classes/main/response/image/class_ImageResponse.php b/inc/classes/main/response/image/class_ImageResponse.php index 27fac282..3cd50146 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 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 @@ -25,11 +25,6 @@ * Michal Cihar , licensed under GNU GPL 2.0. */ class ImageResponse extends BaseResponse implements Responseable { - /** - * Instance of the image - */ - private $imageInstance = null; - /** * Protected constructor * @@ -38,23 +33,26 @@ class ImageResponse extends BaseResponse implements Responseable { protected function __construct () { // Call parent constructor parent::__construct(__CLASS__); + + // Set response type + $this->setResponseType('image'); } /** * 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 final static 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; @@ -63,22 +61,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('template_class' , $cfg->readConfig('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)); } /** @@ -95,7 +93,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 @@ -103,7 +101,9 @@ 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 // For slow browsers set the cookie array element first @@ -111,11 +111,11 @@ class ImageResponse extends BaseResponse implements Responseable { // Get all config entries if (is_null($expires)) { - $expires = (time() + $this->getConfigInstance()->readConfig('cookie_expire')); + $expires = (time() + $this->getConfigInstance()->getConfigEntry('cookie_expire')); } // END - if - $path = $this->getConfigInstance()->readConfig('cookie_path'); - $domain = $this->getConfigInstance()->readConfig('cookie_domain'); + $path = $this->getConfigInstance()->getConfigEntry('cookie_path'); + $domain = $this->getConfigInstance()->getConfigEntry('cookie_domain'); setcookie($cookieName, $cookieValue, $expires); //, $path, $domain, (isset($_SERVER['HTTPS'])) @@ -123,8 +123,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; @@ -149,7 +149,7 @@ class ImageResponse extends BaseResponse implements Responseable { $this->getTemplateInstance()->assignApplicationData($this->getApplicationInstance()); // Get the url from config - $url = $this->getConfigInstance()->readConfig($configEntry . "_url"); + $url = $this->getConfigInstance()->getConfigEntry($configEntry . '_url'); // Compile the URL $url = $this->getTemplateInstance()->compileRawCode($url); @@ -160,11 +160,11 @@ class ImageResponse extends BaseResponse implements Responseable { if (substr($url, 0, 1) == '/') $url = substr($url, 1); // No, then extend it with our base URL - $url = $this->getConfigInstance()->readConfig('base_url') . '/' . $url; + $url = $this->getConfigInstance()->getConfigEntry('base_url') . '/' . $url; } // END - if // Add redirect header - $this->addHeader('Location', $url); + $this->addHeader('Location', str_replace('&', '&', $url)); // Set correct response status $this->setResponseStatus('301 Moved Permanently'); @@ -182,11 +182,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(); @@ -197,7 +197,7 @@ class ImageResponse extends BaseResponse implements Responseable { $this->setResponseBody($content); // Set content type - $this->addHeader('Content-type', "image/".$this->getImageInstance()->getImageType()); + $this->addHeader('Content-type', 'image/' . $this->getImageInstance()->getImageType()); // Call parent method parent::flushBuffer($force); @@ -213,7 +213,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]); @@ -230,38 +230,9 @@ 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 } - - /** - * Setter for image instanxe - * - * @param $imageInstance An instance of an image - * @return void - */ - public final function setImageInstance (BaseImage $imageInstance) { - $this->imageInstance = $imageInstance; - } - - /** - * Getter for image instanxe - * - * @return $imageInstance An instance of an image - */ - public final function getImageInstance () { - return $this->imageInstance; - } - - /** - * Getter for default command - * - * @return $defaultCommand Default command for this response - */ - public function getDefaultCommand () { - $defaultCommand = $this->getConfigInstance()->readConfig('default_image_command'); - return $defaultCommand; - } } // [EOF]