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 Ship-Simu Developer Team
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 * An instance of a controller
61 private $controllerInstance = null;
64 * An instance of this class
66 private static $thisInstance = null;
69 * Protected constructor
73 protected function __construct () {
74 // Call parent constructor
75 parent::__construct(__CLASS__);
79 * Getter for an instance of this class
81 * @return $thisInstance An instance of this class
83 public final static function getInstance () {
84 // Is the instance there?
85 if (is_null(self::$thisInstance)) {
86 self::$thisInstance = new ApplicationHelper();
89 // Return the instance
90 return self::$thisInstance;
94 * Getter for the version number
96 * @return $appVersion The application's version number
98 public final function getAppVersion () {
99 return $this->appVersion;
103 * Setter for the version number
105 * @param $appVersion The application's version number
108 public final function setAppVersion ($appVersion) {
110 $appVersion = (string) $appVersion;
111 $this->appVersion = $appVersion;
115 * Getter for human-readable name
117 * @return $appName The application's human-readable name
119 public final function getAppName () {
120 return $this->appName;
124 * Setter for human-readable name
126 * @param $appName The application's human-readable name
129 public final function setAppName ($appName) {
131 $appName = (string) $appName;
132 $this->appName = $appName;
136 * Getter for short uni*-like name
138 * @return $shortName The application's short uni*-like name
140 public final function getAppShortName () {
141 return $this->shortName;
145 * Setter for short uni*-like name
147 * @param $shortName The application's short uni*-like name
150 public final function setAppShortName ($shortName) {
152 $shortName = (string) $shortName;
153 $this->shortName = $shortName;
157 * Builds the master template's name
159 * @return $masterTemplateName Name of the master template
161 public function buildMasterTemplateName () {
162 // Get short name and add suffix
163 $masterTemplateName = str_replace('-', '', $this->getAppShortName()) . '_main';
166 return $masterTemplateName;
170 * Launches the admin area
174 public final function entryPoint () {
175 // Create a new request object
176 $requestInstance = ObjectFactory::createObjectByName('HttpRequest');
178 // Default response is HTTP (HTML page) and type is 'Web'
180 $responseType = 'web';
182 // Do we have another response?
183 if ($requestInstance->isRequestElementSet('request')) {
185 $response = strtolower($requestInstance->getRequestElement('request'));
186 $responseType = $response;
189 // ... and a new response object
190 $responseClass = sprintf("%sResponse", $this->convertToClassName($response));
191 $responseInstance = ObjectFactory::createObjectByName($responseClass, 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 // Get default command
203 $commandName = $responseInstance->getDefaultCommand();
206 $requestInstance->setRequestElement('page', $commandName);
210 $resolverClass = sprintf("%sControllerResolver", $this->convertToClassName($responseType));
211 $resolverInstance = ObjectFactory::createObjectByName($resolverClass, array($commandName, $this));
213 // Get a controller instance as well
214 $this->controllerInstance = $resolverInstance->resolveController();
216 // Get a web output class
217 $outputInstance = ObjectFactory::createObjectByConfiguredName('output_class', array($this));
219 // Set it in this application
220 $this->setWebOutputInstance($outputInstance);
222 // Handle the request
223 $this->controllerInstance->handleRequest($requestInstance, $responseInstance);
227 * Handle the indexed array of fatal messages and puts them out in an
230 * @param $messageList An array of fatal messages
233 public function handleFatalMessages (array $messageList) {
234 // Walk through all messages
235 foreach ($messageList as $message) {
236 print("MSG:" . $message . "<br />\n");
241 * Assigns application-depending data
243 * @param $templateInstance An instance of a template engine
246 public function assignExtraTemplateData (CompileableTemplate $templateInstance) {
248 $templateInstance->assignConfigVariable('header_charset');