3 * The application selector class.
5 * Please remember that this include file is being loaded *before* the class
6 * loader is loading classes from "exceptions", "interfaces" and "main"!
8 * @author Roland Haeder <webmaster@ship-simu.org>
10 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
11 * @license GNU GPL 3.0 or any newer version
12 * @link http://www.ship-simu.org
14 * This program is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 class ApplicationSelector extends BaseFrameworkSystem {
29 * An ArrayObject for all found applications
31 private $foundApps = null;
34 * An array object for all loaded application templates (selector_app-name.tpl)
36 private $loadedTemplates = null;
39 * The application selector's own template engine handler
41 private $selectorTplEngine = null;
44 * A list of items we shall ignore while reading from directories
46 private $dirIgnoreList = array(
54 * The protected constructor. No direct instances can be created from this.
58 protected function __construct() {
59 // Call parent constructor
60 parent::__construct(__CLASS__);
62 // Remove system array and thousand seperator
63 $this->removeSystemArray();
64 $this->removeNumberFormaters();
66 // Initialize the array lists
67 $this->initializeAppsList();
68 $this->initializeTemplatesList();
72 * Create a prepared instance of ApplicationSelector
74 * @param $langInstance The language sub-system: LanguageSystem
75 * @param $fileIOInstance The file I/O instance
76 * @return $selInstance An instance of ApplicationSelector
78 public final static function createApplicationSelector (ManageableLanguage $langInstance, FileIoHandler $fileIOInstance) {
80 $selInstance = new ApplicationSelector();
82 // Get all applications
83 $selInstance->readApplicationDirectory();
85 // Set language and file I/O instances
86 $selInstance->setLanguageInstance($langInstance);
87 $selInstance->setFileIoInstance($fileIOInstance);
89 // Return the prepared instance
94 * Initialize the application list
98 private function initializeAppsList () {
99 $this->foundApps = new FrameworkArrayObject("FakedFoundApplications");
103 * Initialize the loaded templates list
107 private function initializeTemplatesList () {
108 $this->loadedTemplates = new FrameworkArrayObject("FakedLoadedTemplates");
112 * Load the data.php script of an application and append the application
113 * instance to $foundApps
115 * @param $appData The FQFN of data.php
116 * @param $appName The application's Uni* name
119 private function loadApplicationData ($appData, $appName) {
120 // Is it a file and readable?
121 if ((is_file($appData)) && (is_readable($appData))) {
125 // Add the current instance to the list
126 $this->foundApps->append($app);
128 } // END - if ((is_file(...
132 * Setter for the selector's template engine instance
134 * @param $templateInstance An instance of TemplateEngine
137 private final function setSelectorTemplateEngine (CompileableTemplate $templateInstance) {
138 $this->selectorTplEngine = $templateInstance;
142 * Getter for the selector's template engine instance
144 * @return $selectTplEngine The selector's template engine
146 private final function getSelectorTemplateEngine () {
147 return $this->selectorTplEngine;
151 * Getter for the $loadedTemplates array object
153 * @return $loadedTemplates An array object holding all loaded
154 * application templates
156 private final function getLoadedTemplates () {
157 return $this->loadedTemplates;
161 * Method for compatiblity with prepareTemplateInstance()
163 * @return $shortName This selector's short name
165 public function getAppShortName() {
166 $shortName = $this->getConfigInstance()->readConfig('selector_path');
171 * Add a directory/file to the ignore list
173 * @param $ignoreItem The file/directory we shall ignore
176 public function addDirIgnoreList ($ignoreItem) {
178 $ignoreItem = (string) $ignoreItem;
179 $this->dirIgnoreList[] = $ignoreItem;
183 * Read the base path for all applications (application/) and create a
184 * list of all found applications
188 public function readApplicationDirectory () {
189 // Generate the base path for all applications
190 $appBasePath = $this->getConfigInstance()->readConfig('application_path');
192 // Add the selector path to the ignore list
193 $this->addDirIgnoreList($this->getConfigInstance()->readConfig('selector_path'));
195 // Get a directory pointer for the application path
196 $dirInstance = FrameworkDirectoryPointer::createFrameworkDirectoryPointer($appBasePath);
198 // Backup and remove the 'app' from local name space
202 // Read all directories&files except some parts
203 while ($appName = $dirInstance->readDirectoryExcept($this->dirIgnoreList)) {
204 // Generate FQFN for the application name (or better directory name)
205 $fqfn = sprintf("%s%s", $appBasePath, $appName);
207 // Is this a readable directory? (files will be ignored silently)
208 if ((is_dir($fqfn)) && (is_readable($fqfn))) {
209 // Then get the data.php script for analyzing
210 $appData = sprintf("%s/data.php", $fqfn);
212 // Load the application's data.php script and append the
213 // application to the ArrayObject
214 $this->loadApplicationData($appData, $appName);
218 // Close directory pointer
219 $dirInstance->closeDirectory();
221 // Restore old 'app' from backup
226 * Load all templates for found applications in previous scan
230 public function loadApplicationTemplates () {
231 // Iterate through all applications
232 for ($idx = $this->foundApps->getIterator(); $idx->valid(); $idx->next()) {
233 // Get current application
234 $appInstance = $idx->current();
236 // Prepare the template engine for the current template
237 $templateInstance = $this->prepareTemplateInstance($appInstance);
239 // Try to load the web template
240 $templateInstance->loadWebTemplate(sprintf("%s_%s",
241 $this->getConfigInstance()->readConfig('tpl_selector_prefix'),
242 strtolower($appInstance->getAppShortName())
245 // Remember this template and the application for later usage
246 $this->loadedTemplates->append(array(
247 'template_class' => $templateInstance,
248 'app_instance' => $appInstance
252 // Re-initialize the application list to avoid double loading
253 $this->initializeAppsList();
257 * Removes $dirIgnoreList from the object to save some memory
261 public final function removeDirIgnoreList () {
262 unset($this->dirIgnoreList);
266 * Loads the selector's own main template. This step is not linking the
267 * application's templates into the main one.
271 public function loadSelectorTemplate () {
272 // Prepare the template engine
273 $templateInstance = $this->prepareTemplateInstance($this);
275 // Load the selector's template
276 $templateInstance->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_main_tpl'));
278 // Now store it in the class
279 $this->setSelectorTemplateEngine($templateInstance);
283 * Inserts all loaded application templates into the selector's template
286 * @throws NullPointerException If $curr is null
287 * @throws NoArrayException If $curr is not an array
288 * @throws InvalidArrayCountException If $curr contains an
289 * unexpected count of elements
290 * @throws MissingArrayElementsException If $curr is missing expected
293 public function insertApplicationTemplates () {
294 // First prepare the instance
295 $templateInstance = $this->prepareTemplateInstance($this);
297 // Load template which shall later hold all application templates
298 $templateInstance->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_apps_tpl'));
300 // Add all loaded application templates together
302 for ($idx = $this->getLoadedTemplates()->getIterator(); $idx->valid(); $idx->next()) {
303 // Get current item from array object
304 $curr = $idx->current();
306 // Do some sanity checks on the loaded item
307 if (is_null($curr)) {
309 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
310 } elseif (!is_array($curr)) {
312 throw new NoArrayException($curr, self::EXCEPTION_IS_NO_ARRAY);
313 } elseif (count($curr) != 2) {
314 // Not expected count of entries
315 throw new InvalidArrayCountException(array($this, "curr", count($curr), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
316 } elseif (!isset($curr['template_class']) || (!isset($curr['app_instance']))) {
317 // Expected entries missing
318 throw new MissingArrayElementsException(array($this, "curr", array("template_class", "app_instance")), self::EXCEPTION_ARRAY_ELEMENTS_MISSING);
320 die("<pre>".print_r($curr, true)."</pre>");