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, this is free software
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 {
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 private function __construct () {
68 // Call parent constructor
69 parent::constructor(__CLASS__);
72 $this->setPartDescr("Application-Helper");
74 // Create an unique ID
75 $this->createUniqueID();
78 $this->removeSystemArray();
82 * Getter for an instance of this class
84 * @return $thisInstance An instance of this class
86 public final static function getInstance () {
87 // Is the instance there?
88 if (is_null(self::$thisInstance)) {
89 self::$thisInstance = new ApplicationHelper();
92 // Return the instance
93 return self::$thisInstance;
97 * Getter for the version number
99 * @return $appVersion The application's version number
101 public final function getAppVersion () {
102 return $this->appVersion;
105 * Setter for the version number
107 * @param $appVersion The application's version number
110 public final function setAppVersion ($appVersion) {
112 $appVersion = (string) $appVersion;
113 $this->appVersion = $appVersion;
117 * Getter for human-readable name
119 * @return $appName The application's human-readable name
121 public final function getAppName () {
122 return $this->appName;
126 * Setter for human-readable name
128 * @param $appName The application's human-readable name
131 public final function setAppName ($appName) {
133 $appName = (string) $appName;
134 $this->appName = $appName;
138 * Getter for short uni*-like name
140 * @return $shortName The application's short uni*-like name
142 public final function getAppShortName () {
143 return $this->shortName;
147 * Setter for short uni*-like name
149 * @param $shortName The application's short uni*-like name
152 public final function setAppShortName ($shortName) {
154 $shortName = (string) $shortName;
155 $this->shortName = $shortName;
159 * Launches the hub system
163 public final function entryPoint () {
164 // Get a core loop instance
165 $hubInstance = HubCoreLoop::createHubCoreLoop();
168 $hubInstance->outputIntro();
170 // Contact the master hub
171 $hubInstance->contactMasterHub();
173 // The main loop begins here
174 $hubInstance->coreLoop();
177 $hubInstance->shutdownHub();