framework/main/classes/response/class_BaseResponse.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Response;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
   7 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
   8
   9 /**
  10  * A generic request class
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  *
  31  * The extended headers are taken from phpMyAdmin setup tool, written by
  32  * Michal Cihar <michal@cihar.com>, licensed under GNU GPL 2.0.
  33  */
  34 abstract class BaseResponse extends BaseFrameworkSystem {
  35         /**
  36          * Response status
  37          */
  38         private $responseStatus = '200 OK';
  39
  40         /**
  41          * Array with all headers
  42          */
  43         private $responseHeaders = array();
  44
  45         /**
  46          * Cookies we shall sent out
  47          */
  48         private $cookies = array();
  49
  50         /**
  51          * Body of the response
  52          */
  53         private $responseBody = '';
  54
  55         /**
  56          * Instance of the template engine
  57          */
  58         private $templateInstance = NULL;
  59
  60         /**
  61          * Response type
  62          */
  63         private $responseType = 'invalid';
  64
  65         /**
  66          * Protected constructor
  67          *
  68          * @param       $className      Name of the concrete response
  69          * @return      void
  70          */
  71         protected function __construct ($className) {
  72                 // Call parent constructor
  73                 parent::__construct($className);
  74         }
  75
  76         /**
  77          * Setter for status
  78          *
  79          * @param       $status         New response status
  80          * @return      void
  81          */
  82         public final function setResponseStatus ($status) {
  83                 $this->responseStatus = (string) $status;
  84         }
  85
  86         /**
  87          * Add header element
  88          *
  89          * @param       $name   Name of header element
  90          * @param       $value  Value of header element
  91          * @return      void
  92          */
  93         public final function addHeader ($name, $value) {
  94                 $this->responseHeaders[$name] = $value;
  95         }
  96
  97         /**
  98          * Reset the header array
  99          *
 100          * @return      void
 101          */
 102         public final function resetResponseHeaders () {
 103                 $this->responseHeaders = array();
 104         }
 105
 106         /**
 107          * "Writes" data to the response body
 108          *
 109          * @param       $output         Output we shall sent in the HTTP response
 110          * @return      void
 111          */
 112         public final function writeToBody ($output) {
 113                 $this->responseBody .= $output;
 114         }
 115
 116         /**
 117          * Sets the response body to something new
 118          *
 119          * @param       $output         Output we shall sent in the HTTP response
 120          * @return      void
 121          */
 122         public final function setResponseBody ($output) {
 123                 $this->responseBody = $output;
 124         }
 125
 126         /**
 127          * Setter for response type
 128          *
 129          * @param       $responseType   Response type
 130          * @return      void
 131          */
 132         protected final function setResponseType ($responseType) {
 133                 $this->responseType = $responseType;
 134         }
 135
 136         /**
 137          * Getter for response type
 138          *
 139          * @param       $responseType   Response type
 140          * @return      void
 141          */
 142         public final function getResponseType () {
 143                 return $this->responseType;
 144         }
 145
 146         /**
 147          * Adds a fatal message id to the response. The added messages can then be
 148          * processed and outputed to the world
 149          *
 150          * @param       $messageId      The message id we shall add
 151          * @return      void
 152          */
 153         public final function addFatalMessage ($messageId) {
 154                 // Get application instance
 155                 $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
 156
 157                 // Adds the resolved message id to the fatal message list
 158                 $this->addFatalMessagePlain($applicationInstance->getLanguageInstance()->getMessage($messageId));
 159         }
 160
 161         /**
 162          * Adds a plain fatal message id to the response
 163          *
 164          * @param       $message        The plain message we shall add
 165          * @return      void
 166          */
 167         public final function addFatalMessagePlain ($message) {
 168                 // Adds the resolved message id to the fatal message list
 169                 $this->pushValueToGenericArrayKey('fatal_messages', 'generic', 'message', $message);
 170         }
 171
 172         /**
 173          * Flushs the cached HTTP response to the outer world
 174          *
 175          * @param       $force  Whether we shall force the output or abort if headers are
 176          *                                      already sent with an exception
 177          * @return      void
 178          * @throws      ResponseHeadersAlreadySentException             Thrown if headers are
 179          *                                                                                                      already sent
 180          */
 181         public function flushBuffer ($force = false) {
 182                 // Get application instance
 183                 $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
 184
 185                 // Headers already sent?
 186                 if ((headers_sent()) && ($force === false)) {
 187                         // Headers are already sent!
 188                         throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
 189                 } elseif (!headers_sent()) {
 190                         // Send headers out
 191                         header('HTTP/1.1 ' . $this->responseStatus);
 192
 193                         // Used later
 194                         $now = gmdate('D, d M Y H:i:s') . ' GMT';
 195
 196                         // General header for no caching
 197                         $this->addHeader('Expired', $now); // RFC2616 - Section 14.21
 198                         $this->addHeader('Last-Modified', $now);
 199                         $this->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
 200                         $this->addHeader('Pragma', 'no-cache'); // HTTP/1.0
 201
 202                         // Define the charset to be used
 203                         //$this->addHeader('Content-type:', sprintf("text/html; charset=%s", $this->getConfigInstance()->getConfigEntry('header_charset')));
 204
 205                         // Send all headers
 206                         foreach ($this->responseHeaders as $name => $value) {
 207                                 header($name . ': ' . $value);
 208                                 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('name=' . $name . ',value=' . $value);
 209                         } // END - foreach
 210
 211                         // Send cookies out?
 212                         if (count($this->cookies) > 0) {
 213                                 // Send all cookies
 214                                 $cookieString = implode(' ', $this->cookies);
 215                                 header('Set-Cookie: ' . $cookieString);
 216
 217                                 // Remove them all
 218                                 $this->cookies = array();
 219                         } // END - if
 220                 }
 221
 222                 // Are there some error messages?
 223                 if ((!$this->isValidGenericArrayKey('fatal_messages', 'generic', 'message')) || ($this->countGenericArrayElements('fatal_messages', 'generic', 'message') == 0)) {
 224                         // Flush the output to the world
 225                         $this->getWebOutputInstance()->output($this->responseBody);
 226                 } else {
 227                         // Display all error messages
 228                         $applicationInstance->handleFatalMessages($this->getGenericArrayKey('fatal_messages', 'generic', 'message'));
 229
 230                         // Send the error messages out to the world
 231                         $this->getWebOutputInstance()->output($this->responseBody);
 232                 }
 233
 234                 // Clear response header and body
 235                 $this->setResponseBody('');
 236                 $this->resetResponseHeaders();
 237         }
 238
 239         /**
 240          * "Getter" for default command
 241          *
 242          * @return      $defaultCommand         Default command for this response
 243          */
 244         public function determineDefaultCommand () {
 245                 // Get application instance
 246                 $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
 247
 248                 // Generate config key
 249                 $configKey = sprintf('default_%s_%s_command',
 250                         $applicationInstance->getAppShortName(),
 251                         $this->getResponseType()
 252                 );
 253
 254                 // Get default command response
 255                 $defaultCommand = $this->getConfigInstance()->getConfigEntry($configKey);
 256
 257                 // Return it
 258                 return $defaultCommand;
 259         }
 260
 261 }