/**
* A class for a console response aka output to console
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
/**
* Creates an object of this class
*
- * @param $appInstance An instance of a manageable application
- * @return $responseInstance A prepared instance of this class
+ * @param $applicationInstance An instance of a manageable application
+ * @return $responseInstance A prepared instance of this class
*/
- public static final function createConsoleResponse (ManageableApplication $appInstance) {
+ public static final function createConsoleResponse (ManageableApplication $applicationInstance) {
// Get a new instance
$responseInstance = new ConsoleResponse();
// Set the application instance
- $responseInstance->setApplicationInstance($appInstance);
+ $responseInstance->setApplicationInstance($applicationInstance);
// Initialize the template engine here
- $responseInstance->initTemplateEngine($appInstance);
+ $responseInstance->initTemplateEngine($applicationInstance);
// Return the prepared instance
return $responseInstance;
/**
* Initializes the template engine instance
*
- * @param $appInstance An instance of a manageable application
+ * @param $applicationInstance An instance of a manageable application
* @return void
*/
- public final function initTemplateEngine (ManageableApplication $appInstance) {
- $this->setTemplateInstance($this->prepareTemplateInstance($appInstance));
+ public final function initTemplateEngine (ManageableApplication $applicationInstance) {
+ $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
}
/**
* @return void
* @throws ResponseHeadersAlreadySentException If headers are already sent
*/
- public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = null) {
+ public function addCookie ($cookieName, $cookieValue, $encrypted = FALSE, $expires = NULL) {
//* DEBUG: */ echo $cookieName.'='.$cookieValue."<br />\n";
$this->partialStub('Naturally unimplemented in console response.');
}
/**
* Flushs the cached console response to the console
*
- * @param $force Wether we shall force the output or abort if headers are
+ * @param $force Whether we shall force the output or abort if headers are
* already sent with an exception
* @return void
* @throws ResponseHeadersAlreadySentException Thrown if headers are
* already sent
*/
- public function flushBuffer ($force = false) {
+ public function flushBuffer ($force = FALSE) {
$this->partialStub('Please implement this class.');
}
}