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
  38         /**
  39          * Creates an object of this class
  40          *
  41          * @param       $applicationInstance    An instance of a manageable application
  42          * @return      $responseInstance               A prepared instance of this class
  43          */
  44         public static final function createConsoleResponse (ManageableApplication $applicationInstance) {
  45                 // Get a new instance
  46                 $responseInstance = new ConsoleResponse();
  47
  48                 // Set the application instance
  49                 $responseInstance->setApplicationInstance($applicationInstance);
  50
  51                 // Initialize the template engine here
  52                 $responseInstance->initTemplateEngine($applicationInstance);
  53
  54                 // Init web output instance
  55                 $responseInstance->initWebOutputInstance();
  56
  57                 // Return the prepared instance
  58                 return $responseInstance;
  59         }
  60
  61         /**
  62          * Initializes the template engine instance
  63          *
  64          * @param       $applicationInstance    An instance of a manageable application
  65          * @return      void
  66          */
  67         public final function initTemplateEngine (ManageableApplication $applicationInstance) {
  68                 $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
  69         }
  70
  71         /**
  72          * Adds a cookie to the response
  73          *
  74          * @param       $cookieName             Cookie's name
  75          * @param       $cookieValue    Value to store in the cookie
  76          * @param       $encrypted              Do some extra encryption on the value
  77          * @param       $expires                Timestamp of expiration (default: configured)
  78          * @return      void
  79          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
  80          */
  81         public function addCookie ($cookieName, $cookieValue, $encrypted = FALSE, $expires = NULL) {
  82                 //* DEBUG: */ echo $cookieName.'='.$cookieValue."<br />\n";
  83                 $this->partialStub('Naturally unimplemented in console response.');
  84         }
  85
  86         /**
  87          * Redirect to a configured URL. The URL can be absolute or relative. In
  88          * case of relative URL it will be extended automatically.
  89          *
  90          * @param       $configEntry    The configuration entry which holds our URL
  91          * @return      void
  92          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
  93          */
  94         public function redirectToConfiguredUrl ($configEntry) {
  95                 $this->partialStub('Naturally unimplemented in console response.');
  96         }
  97
  98         /**
  99          * Expires the given cookie if it is set
 100          *
 101          * @param       $cookieName             Cookie to expire
 102          * @return      void
 103          */
 104         public function expireCookie ($cookieName) {
 105                 $this->partialStub('Naturally unimplemented in console response.');
 106         }
 107
 108         /**
 109          * Refreshs a given cookie. This will make the cookie live longer
 110          *
 111          * @param       $cookieName             Cookie to refresh
 112          * @return      void
 113          */
 114         public function refreshCookie ($cookieName) {
 115                 $this->partialStub('Naturally unimplemented in console response.');
 116         }
 117
 118         /**
 119          * Getter for default command
 120          *
 121          * @return      $defaultCommand         Default command for this response
 122          */
 123         public function getDefaultCommand () {
 124                 $defaultCommand = $this->getConfigInstance()->getConfigEntry('default_console_command');
 125                 return $defaultCommand;
 126         }
 127
 128         /**
 129          * Flushs the cached console response to the console
 130          *
 131          * @param       $force  Whether we shall force the output or abort if headers are
 132          *                                      already sent with an exception
 133          * @return      void
 134          * @throws      ResponseHeadersAlreadySentException             Thrown if headers are
 135          *                                                                                                      already sent
 136          */
 137         public function flushBuffer ($force = FALSE) {
 138                 $this->partialStub('Please implement this class.');
 139         }
 140 }
 141
 142 // [EOF]
 143 ?>