framework/main/classes/response/console/class_ConsoleResponse.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Response;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Response\Responseable;
   7
   8 /**
   9  * A class for a console response aka output to console
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  *
  30  * The extended headers are taken from phpMyAdmin setup tool, written by
  31  * Michal Cihar <michal@cihar.com>, licensed under GNU GPL 2.0.
  32  */
  33 class ConsoleResponse extends BaseResponse implements Responseable {
  34         /**
  35          * Protected constructor
  36          *
  37          * @return      void
  38          */
  39         protected function __construct () {
  40                 // Call parent constructor
  41                 parent::__construct(__CLASS__);
  42
  43                 // Set response type
  44                 $this->setResponseType('console');
  45         }
  46
  47         /**
  48          * Creates an object of this class
  49          *
  50          * @return      $responseInstance       A prepared instance of this class
  51          */
  52         public static final function createConsoleResponse () {
  53                 // Get a new instance
  54                 $responseInstance = new ConsoleResponse();
  55
  56                 // Return the prepared instance
  57                 return $responseInstance;
  58         }
  59
  60         /**
  61          * Initializes the template engine instance
  62          *
  63          * @param       $applicationInstance    An instance of a manageable application
  64          * @return      void
  65          */
  66         public final function initTemplateEngine (ManageableApplication $applicationInstance) {
  67                 $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
  68         }
  69
  70         /**
  71          * Adds a cookie to the response
  72          *
  73          * @param       $cookieName             Cookie's name
  74          * @param       $cookieValue    Value to store in the cookie
  75          * @param       $encrypted              Do some extra encryption on the value
  76          * @param       $expires                Timestamp of expiration (default: configured)
  77          * @return      void
  78          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
  79          */
  80         public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = NULL) {
  81                 //* DEBUG: */ echo $cookieName.'='.$cookieValue."<br />\n";
  82                 $this->partialStub('Naturally unimplemented in console response.');
  83         }
  84
  85         /**
  86          * Redirect to a configured URL. The URL can be absolute or relative. In
  87          * case of relative URL it will be extended automatically.
  88          *
  89          * @param       $configEntry    The configuration entry which holds our URL
  90          * @return      void
  91          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
  92          */
  93         public function redirectToConfiguredUrl ($configEntry) {
  94                 $this->partialStub('Naturally unimplemented in console response.');
  95         }
  96
  97         /**
  98          * Expires the given cookie if it is set
  99          *
 100          * @param       $cookieName             Cookie to expire
 101          * @return      void
 102          */
 103         public function expireCookie ($cookieName) {
 104                 $this->partialStub('Naturally unimplemented in console response.');
 105         }
 106
 107         /**
 108          * Refreshs a given cookie. This will make the cookie live longer
 109          *
 110          * @param       $cookieName             Cookie to refresh
 111          * @return      void
 112          */
 113         public function refreshCookie ($cookieName) {
 114                 $this->partialStub('Naturally unimplemented in console response.');
 115         }
 116
 117         /**
 118          * Flushs the cached console response to the console
 119          *
 120          * @param       $force  Whether we shall force the output or abort if headers are
 121          *                                      already sent with an exception
 122          * @return      void
 123          * @throws      ResponseHeadersAlreadySentException             Thrown if headers are already sent
 124          */
 125         public function flushBuffer ($force = false) {
 126                 $this->partialStub('Please implement this class.');
 127         }
 128
 129 }