3 * A class for a console response aka output to console
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 * The extended headers are taken from phpMyAdmin setup tool, written by
25 * Michal Cihar <michal@cihar.com>, licensed under GNU GPL 2.0.
27 class ConsoleResponse extends BaseResponse implements Responseable {
29 * Protected constructor
33 protected function __construct () {
34 // Call parent constructor
35 parent::__construct(__CLASS__);
39 * Creates an object of this class
41 * @param $applicationInstance An instance of a manageable application
42 * @return $responseInstance A prepared instance of this class
44 public static final function createConsoleResponse (ManageableApplication $applicationInstance) {
46 $responseInstance = new ConsoleResponse();
48 // Set the application instance
49 $responseInstance->setApplicationInstance($applicationInstance);
51 // Initialize the template engine here
52 $responseInstance->initTemplateEngine($applicationInstance);
54 // Return the prepared instance
55 return $responseInstance;
59 * Initializes the template engine instance
61 * @param $applicationInstance An instance of a manageable application
64 public final function initTemplateEngine (ManageableApplication $applicationInstance) {
65 $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
69 * Adds a cookie to the response
71 * @param $cookieName Cookie's name
72 * @param $cookieValue Value to store in the cookie
73 * @param $encrypted Do some extra encryption on the value
74 * @param $expires Timestamp of expiration (default: configured)
76 * @throws ResponseHeadersAlreadySentException If headers are already sent
78 public function addCookie ($cookieName, $cookieValue, $encrypted = FALSE, $expires = NULL) {
79 //* DEBUG: */ echo $cookieName.'='.$cookieValue."<br />\n";
80 $this->partialStub('Naturally unimplemented in console response.');
84 * Redirect to a configured URL. The URL can be absolute or relative. In
85 * case of relative URL it will be extended automatically.
87 * @param $configEntry The configuration entry which holds our URL
89 * @throws ResponseHeadersAlreadySentException If headers are already sent
91 public function redirectToConfiguredUrl ($configEntry) {
92 $this->partialStub('Naturally unimplemented in console response.');
96 * Expires the given cookie if it is set
98 * @param $cookieName Cookie to expire
101 public function expireCookie ($cookieName) {
102 $this->partialStub('Naturally unimplemented in console response.');
106 * Refreshs a given cookie. This will make the cookie live longer
108 * @param $cookieName Cookie to refresh
111 public function refreshCookie ($cookieName) {
112 $this->partialStub('Naturally unimplemented in console response.');
116 * Getter for default command
118 * @return $defaultCommand Default command for this response
120 public function getDefaultCommand () {
121 $defaultCommand = $this->getConfigInstance()->getConfigEntry('default_console_command');
122 return $defaultCommand;
126 * Flushs the cached console response to the console
128 * @param $force Whether we shall force the output or abort if headers are
129 * already sent with an exception
131 * @throws ResponseHeadersAlreadySentException Thrown if headers are
134 public function flushBuffer ($force = FALSE) {
135 $this->partialStub('Please implement this class.');