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
27 * @link http://www.ship-simu.org
29 * This program is free software: you can redistribute it and/or modify
30 * it under the terms of the GNU General Public License as published by
31 * the Free Software Foundation, either version 3 of the License, or
32 * (at your option) any later version.
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
39 * You should have received a copy of the GNU General Public License
40 * along with this program. If not, see <http://www.gnu.org/licenses/>.
42 class ApplicationHelper extends BaseApplication implements ManageableApplication, Registerable {
44 * The version number of this application
46 private $appVersion = "";
49 * The human-readable name for this application
51 private $appName = "";
54 * The short uni*-like name for this application
56 private $shortName = "";
59 * The name of the master template
61 private $masterTemplate = "blog_main";
64 * An instance of a controller
66 private $controllerInstance = null;
69 * An instance of this class
71 private static $thisInstance = null;
74 * Protected constructor
78 protected function __construct () {
79 // Call parent constructor
80 parent::__construct(__CLASS__);
84 * Getter for an instance of this class
86 * @return $thisInstance An instance of this class
88 public final static function getInstance () {
89 // Is the instance there?
90 if (is_null(self::$thisInstance)) {
91 self::$thisInstance = new ApplicationHelper();
94 // Return the instance
95 return self::$thisInstance;
99 * Getter for the version number
101 * @return $appVersion The application's version number
103 public final function getAppVersion () {
104 return $this->appVersion;
108 * Setter for the version number
110 * @param $appVersion The application's version number
113 public final function setAppVersion ($appVersion) {
115 $appVersion = (string) $appVersion;
116 $this->appVersion = $appVersion;
120 * Getter for human-readable name
122 * @return $appName The application's human-readable name
124 public final function getAppName () {
125 return $this->appName;
129 * Setter for human-readable name
131 * @param $appName The application's human-readable name
134 public final function setAppName ($appName) {
136 $appName = (string) $appName;
137 $this->appName = $appName;
141 * Getter for short uni*-like name
143 * @return $shortName The application's short uni*-like name
145 public final function getAppShortName () {
146 return $this->shortName;
150 * Setter for short uni*-like name
152 * @param $shortName The application's short uni*-like name
155 public final function setAppShortName ($shortName) {
157 $shortName = (string) $shortName;
158 $this->shortName = $shortName;
162 * Getter for master template name
164 * @return $masterTemplate Name of the master template
166 public final function getMasterTemplate () {
167 return $this->masterTemplate;
171 * Launches the blog software
175 public final function entryPoint () {
176 // Create a new request object
177 $requestInstance = ObjectFactory::createObjectByName('HttpRequest');
179 // Default response is HTTP (HTML page) and type is "Web"
181 $responseType = "web";
183 // Do we have another response?
184 if ($requestInstance->isRequestElementSet('request')) {
186 $response = strtolower($requestInstance->getRequestElement('request'));
187 $responseType = $response;
190 // ... and a new response object
191 $responseInstance = ObjectFactory::createObjectByName(ucfirst($response)."Response", array($this));
193 // Remember both in this application
194 $this->setRequestInstance($requestInstance);
195 $this->setResponseInstance($responseInstance);
197 // Get the parameter from the request
198 $commandName = $requestInstance->getRequestElement('page');
200 // If it is null then get default command
201 if (is_null($commandName)) {
202 $commandName = $responseInstance->getDefaultCommand();
206 $resolverInstance = ObjectFactory::createObjectByName(ucfirst($responseType)."ControllerResolver", array($commandName, $this));
208 // Get a controller instance as well
209 $this->controllerInstance = $resolverInstance->resolveController();
211 // Handle the request
212 $this->controllerInstance->handleRequest($requestInstance, $responseInstance);
216 * Handle the indexed array of fatal messages and puts them out in an
219 * @param $messageList An array of fatal messages
222 public function handleFatalMessages (array $messageList) {
223 // Walk through all messages
224 foreach ($messageList as $message) {
225 print("MSG:".$message."<br />\n");
230 * Assigns application-depending data
232 * @param $templateInstance An instance of a template engine
235 public function assignExtraTemplateData (CompileableTemplate $templateInstance) {
237 $templateInstance->assignConfigVariable('header_charset');