3 * A class holding general data about the application and some methods for
4 * the management including the entry point.
10 * You need to create a folder in the folder "application" named "my_app"
11 * (without the quotes) and create a include file called
12 * class_ApplicationHelper.php. You have to write the same class for your
13 * application and implement the same interface called ManageableApplication
14 * because this class include file will be searched for.
16 * It is good when you avoid more GET parameters to keep URLs short and sweet.
17 * But sometimes you need some GET paramerers e.g. for your imprint or info page
18 * or other linked pages which you have to create and state some informations.
20 * Please remember that this include file is being loaded *before* the class
21 * loader is loading classes from "exceptions", "interfaces" and "main"!
23 * @author Roland Haeder <webmaster@ship-simu.org>
25 * @copyright Copyright (c) 2007 - 2008 Roland Haeder, 2009 Hub Developer Team
26 * @license GNU GPL 3.0 or any newer version
28 * This program is free software: you can redistribute it and/or modify
29 * it under the terms of the GNU General Public License as published by
30 * the Free Software Foundation, either version 3 of the License, or
31 * (at your option) any later version.
33 * This program is distributed in the hope that it will be useful,
34 * but WITHOUT ANY WARRANTY; without even the implied warranty of
35 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
36 * GNU General Public License for more details.
38 * You should have received a copy of the GNU General Public License
39 * along with this program. If not, see <http://www.gnu.org/licenses/>.
41 class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplication, Registerable {
43 * The version number of this application
45 private $appVersion = "";
48 * The human-readable name for this application
50 private $appName = "";
53 * The short uni*-like name for this application
55 private $shortName = "";
58 * An instance of this class
60 private static $thisInstance = null;
67 protected function __construct () {
68 // Call parent constructor
69 parent::__construct(__CLASS__);
72 $this->removeSystemArray();
73 $this->removeNumberFormaters();
77 * Getter for an instance of this class
79 * @return $thisInstance An instance of this class
81 public final static function getInstance () {
82 // Is the instance there?
83 if (is_null(self::$thisInstance)) {
84 self::$thisInstance = new ApplicationHelper();
87 // Return the instance
88 return self::$thisInstance;
92 * Getter for the version number
94 * @return $appVersion The application's version number
96 public final function getAppVersion () {
97 return $this->appVersion;
100 * Setter for the version number
102 * @param $appVersion The application's version number
105 public final function setAppVersion ($appVersion) {
107 $this->appVersion = (string) $appVersion;
111 * Getter for human-readable name
113 * @return $appName The application's human-readable name
115 public final function getAppName () {
116 return $this->appName;
120 * Setter for human-readable name
122 * @param $appName The application's human-readable name
125 public final function setAppName ($appName) {
127 $this->appName = (string) $appName;;
131 * Getter for short uni*-like name
133 * @return $shortName The application's short uni*-like name
135 public final function getAppShortName () {
136 return $this->shortName;
140 * Setter for short uni*-like name
142 * @param $shortName The application's short uni*-like name
145 public final function setAppShortName ($shortName) {
147 $this->shortName = (string) $shortName;
151 * Launches the hub system
155 public final function entryPoint () {
156 // Create a new request object
157 $requestInstance = ObjectFactory::createObjectByName('ConsoleRequest');
159 // Remember request instance here
160 $this->setRequestInstance($requestInstance);
162 // Default response is console
163 $response = 'console';
164 $responseType = 'console';
166 // Do we have another response?
167 if ($requestInstance->isRequestElementSet('request')) {
169 $response = strtolower($requestInstance->getRequestElement('request'));
170 $responseType = $response;
173 // ... and a new response object
174 $responseClass = sprintf("%sResponse", $this->convertToClassName($response));
175 $responseInstance = ObjectFactory::createObjectByName($responseClass, array($this));
177 // Remember response instance here
178 $this->setResponseInstance($responseInstance);
180 // Get the parameter from the request
181 $commandName = $requestInstance->getRequestElement('command');
183 // If it is null then get default command
184 if (is_null($commandName)) {
185 // Get default command
186 $commandName = $responseInstance->getDefaultCommand();
189 $requestInstance->setRequestElement('command', $commandName);
193 $resolverClass = sprintf("Hub%sControllerResolver", $this->convertToClassName($responseType));
194 $resolverInstance = ObjectFactory::createObjectByName($resolverClass, array($commandName, $this));
196 // Get a controller instance as well
197 $this->setControllerInstance($resolverInstance->resolveController());
200 $registryInstance = Registry::getRegistry();
202 // Set this application
203 $registryInstance->addInstance('app', $this);
205 // Launch the hub main routine here
206 $this->getControllerInstance()->handleRequest($requestInstance, $responseInstance);
208 // -------------------------- Shutdown phase --------------------------
209 // Shutting down the hub by saying "good bye" to all connected clients
210 // and other hubs, flushing all queues and caches.
211 $this->debugOutput('MAIN: Shutdown in progress, main loop exited.');
212 $this->getControllerInstance()->executeShutdownFilters($requestInstance, $responseInstance);
213 $this->debugOutput('MAIN: Shutdown completed. (This is the last line.)');
217 * Handle the indexed array of fatal messages and puts them out in an
220 * @param $messageList An array of fatal messages
223 public function handleFatalMessages (array $messageList) {
224 // Walk through all messages
225 foreach ($messageList as $message) {
226 die("MSG:" . $message);
231 * Builds the master template's name
233 * @return $masterTemplateName Name of the master template
235 public function buildMasterTemplateName () {