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

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