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__);
63 $this->setObjectDescription("Applikationswechsler");
65 // Create unique ID number
66 $this->generateUniqueId();
68 // Remove system array and thousand seperator
69 $this->removeSystemArray();
70 $this->removeNumberFormaters();
72 // Initialize the array lists
73 $this->initializeAppsList();
74 $this->initializeTemplatesList();
78 * Create a prepared instance of ApplicationSelector
80 * @param $langInstance The language sub-system: LanguageSystem
81 * @param $fileIOInstance The file I/O instance
82 * @return $selInstance An instance of ApplicationSelector
84 public final static function createApplicationSelector (ManageableLanguage $langInstance, FileIoHandler $fileIOInstance) {
86 $selInstance = new ApplicationSelector();
88 // Get all applications
89 $selInstance->readApplicationDirectory();
91 // Set language and file I/O instances
92 $selInstance->setLanguageInstance($langInstance);
93 $selInstance->setFileIoInstance($fileIOInstance);
95 // Return the prepared instance
100 * Initialize the application list
104 private function initializeAppsList () {
105 $this->foundApps = new FrameworkArrayObject("FakedFoundApplications");
109 * Initialize the loaded templates list
113 private function initializeTemplatesList () {
114 $this->loadedTemplates = new FrameworkArrayObject("FakedLoadedTemplates");
118 * Load the init.php script of an application and append the application
119 * instance to $foundApps
121 * @param $initScript The FQFN of init.php
122 * @param $appName The application's Uni* name
125 private function loadInitScript ($initScript, $appName) {
126 // Is it a file and readable?
127 if ((is_file($initScript)) && (is_readable($initScript))) {
129 include ($initScript);
131 // Add the current instance to the list
132 $this->foundApps->append($app);
134 } // END - if ((is_file(...
138 * Setter for the selector's template engine instance
140 * @param $tplEngine An instance of TemplateEngine
142 private final function setSelectorTemplateEngine (CompileableTemplate $tplEngine) {
143 $this->selectorTplEngine = $tplEngine;
147 * Getter for the selector's template engine instance
149 * @return $selectTplEngine The selector's template engine
151 private final function getSelectorTemplateEngine () {
152 return $this->selectorTplEngine;
156 * Getter for the $loadedTemplates array object
158 * @return $loadedTemplates An array object holding all loaded
159 * application templates
161 private final function getLoadedTemplates () {
162 return $this->loadedTemplates;
166 * Method for compatiblity with prepareTemplateEngine()
168 * @return $shortName This selector's short name
170 public function getAppShortName() {
171 $shortName = $this->getConfigInstance()->readConfig('selector_path');
176 * Add a directory/file to the ignore list
178 * @param $ignoreItem The file/directory we shall ignore
181 public function addDirIgnoreList ($ignoreItem) {
183 $ignoreItem = (string) $ignoreItem;
184 $this->dirIgnoreList[] = $ignoreItem;
188 * Read the base path for all applications (application/) and create a
189 * list of all found applications
193 public function readApplicationDirectory () {
194 // Generate the base path for all applications
195 $appBasePath = sprintf("%s%s/",
197 $this->getConfigInstance()->readConfig('application_path')
200 // Add the selector path to the ignore list
201 $this->addDirIgnoreList($this->getConfigInstance()->readConfig('selector_path'));
203 // Get a directory pointer for the application path
204 $dirInstance = FrameworkDirectoryPointer::createFrameworkDirectoryPointer($appBasePath);
206 // Backup and remove the 'app' from global name space
210 // Read all directories&files except some parts
211 while ($appName = $dirInstance->readDirectoryExcept($this->dirIgnoreList)) {
212 // Generate FQFN for the application name (or better directory name)
213 $fqfn = sprintf("%s%s", $appBasePath, $appName);
215 // Is this a readable directory? (files will be ignored silently)
216 if ((is_dir($fqfn)) && (is_readable($fqfn))) {
217 // Then get the init.php script for analyzing
218 $initScript = sprintf("%s/init%s", $fqfn, $this->getConfigInstance()->readConfig('php_extension'));
220 // Load the application's init.php script and append the
221 // application to the ArrayObject
222 $this->loadInitScript($initScript, $appName);
224 } // END - if ((is_dir(...
228 // Close directory pointer
229 $dirInstance->closeDirectory();
231 // Restore old 'app' from backup
236 * Load all templates for found applications in previous scan
240 public function loadApplicationTemplates () {
241 // Iterate through all applications
242 for ($idx = $this->foundApps->getIterator(); $idx->valid(); $idx->next()) {
243 // Get current application
244 $appInstance = $idx->current();
246 // Prepare the template engine for the current template
247 $tplEngine = $this->prepareTemplateEngine($appInstance);
249 // Try to load the web template
250 $tplEngine->loadWebTemplate(sprintf("%s_%s",
251 $this->getConfigInstance()->readConfig('tpl_selector_prefix'),
252 strtolower($appInstance->getAppShortName())
255 // Remember this template and the application for later usage
256 $this->loadedTemplates->append(array(
257 'template_class' => $tplEngine,
258 'app_instance' => $appInstance
262 // Re-initialize the application list to avoid double loading
263 $this->initializeAppsList();
267 * Removes $dirIgnoreList from the object to save some memory
271 public final function removeDirIgnoreList () {
272 unset($this->dirIgnoreList);
276 * Loads the selector's own main template. This step is not linking the
277 * application's templates into the main one.
281 public function loadSelectorTemplate () {
282 // Prepare the template engine
283 $tplEngine = $this->prepareTemplateEngine($this);
285 // Load the selector's template
286 $tplEngine->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_main_tpl'));
288 // Now store it in the class
289 $this->setSelectorTemplateEngine($tplEngine);
293 * Inserts all loaded application templates into the selector's template
296 * @throws NullPointerException If $curr is null
297 * @throws NoArrayException If $curr is not an array
298 * @throws InvalidArrayCountException If $curr contains an
299 * unexpected count of elements
300 * @throws MissingArrayElementsException If $curr is missing expected
303 public function insertApplicationTemplates () {
304 // First prepare the instance
305 $tplEngine = $this->prepareTemplateEngine($this);
307 // Load template which shall later hold all application templates
308 $tplEngine->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_apps_tpl'));
310 // Add all loaded application templates together
312 for ($idx = $this->getLoadedTemplates()->getIterator(); $idx->valid(); $idx->next()) {
313 // Get current item from array object
314 $curr = $idx->current();
316 // Do some sanity checks on the loaded item
317 if (is_null($curr)) {
319 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
320 } elseif (!is_array($curr)) {
322 throw new NoArrayException($curr, self::EXCEPTION_IS_NO_ARRAY);
323 } elseif (count($curr) != 2) {
324 // Not expected count of entries
325 throw new InvalidArrayCountException(array($this, "curr", count($curr), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
326 } elseif (!isset($curr['template_class']) || (!isset($curr['app_instance']))) {
327 // Expected entries missing
328 throw new MissingArrayElementsException(array($this, "curr", array('template_class', 'app_instance')), self::EXCEPTION_ARRAY_ELEMENTS_MISSING);
330 die("<pre>".print_r($curr, true)."</pre>");