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
124 * @throws AppVarIsNotSetException If 'app' is not set
125 * @throws NullPointerException If 'app' is null
126 * @throws NoObjectException If 'app' is not an object
127 * @throws MissingMethodException If a required method is missing
129 private function loadInitScript ($initScript, $appName) {
130 // Is it a file and readable?
131 if ((is_file($initScript)) && (is_readable($initScript))) {
133 include ($initScript);
135 // We now should have $app re-defined!
137 // This application shall not be loaded
139 } elseif (is_null($app)) {
140 // The class instance is null
141 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
142 } elseif (!is_object($app)) {
144 throw new NoObjectException($app, self::EXCEPTION_IS_NO_OBJECT);
145 } elseif (!method_exists($app, $this->getConfigInstance()->readConfig('entry_method'))) {
147 throw new MissingMethodException(array($app, $this->getConfigInstance()->readConfig('entry_method')), self::EXCEPTION_MISSING_METHOD);
150 // Add the current instance to the list
151 $this->foundApps->append($app);
153 } // END - if ((is_file(...
157 * Setter for the selector's template engine instance
159 * @param $tplEngine An instance of TemplateEngine
161 private final function setSelectorTemplateEngine (CompileableTemplate $tplEngine) {
162 $this->selectorTplEngine = $tplEngine;
166 * Getter for the selector's template engine instance
168 * @return $selectTplEngine The selector's template engine
170 private final function getSelectorTemplateEngine () {
171 return $this->selectorTplEngine;
175 * Getter for the $loadedTemplates array object
177 * @return $loadedTemplates An array object holding all loaded
178 * application templates
180 private final function getLoadedTemplates () {
181 return $this->loadedTemplates;
185 * Method for compatiblity with prepareTemplateEngine()
187 * @return $shortName This selector's short name
189 public function getAppShortName() {
190 $shortName = $this->getConfigInstance()->readConfig('selector_path');
195 * Add a directory/file to the ignore list
197 * @param $ignoreItem The file/directory we shall ignore
200 public function addDirIgnoreList ($ignoreItem) {
202 $ignoreItem = (string) $ignoreItem;
203 $this->dirIgnoreList[] = $ignoreItem;
207 * Read the base path for all applications (application/) and create a
208 * list of all found applications
212 public function readApplicationDirectory () {
213 // Generate the base path for all applications
214 $appBasePath = sprintf("%s%s/",
216 $this->getConfigInstance()->readConfig('application_path')
219 // Add the selector path to the ignore list
220 $this->addDirIgnoreList($this->getConfigInstance()->readConfig('selector_path'));
222 // Get a directory pointer for the application path
223 $dirInstance = FrameworkDirectoryPointer::createFrameworkDirectoryPointer($appBasePath);
225 // Backup and remove the 'app' from global name space
229 // Read all directories&files except some parts
230 while ($appName = $dirInstance->readDirectoryExcept($this->dirIgnoreList)) {
231 // Generate FQFN for the application name (or better directory name)
232 $fqfn = sprintf("%s%s", $appBasePath, $appName);
234 // Is this a readable directory? (files will be ignored silently)
235 if ((is_dir($fqfn)) && (is_readable($fqfn))) {
236 // Then get the init.php script for analyzing
237 $initScript = sprintf("%s/init%s", $fqfn, $this->getConfigInstance()->readConfig('php_extension'));
239 // Load the application's init.php script and append the
240 // application to the ArrayObject
241 $this->loadInitScript($initScript, $appName);
243 } // END - if ((is_dir(...
247 // Close directory pointer
248 $dirInstance->closeDirectory();
250 // Restore old 'app' from backup
255 * Load all templates for found applications in previous scan
259 public function loadApplicationTemplates () {
260 // Iterate through all applications
261 for ($idx = $this->foundApps->getIterator(); $idx->valid(); $idx->next()) {
262 // Get current application
263 $appInstance = $idx->current();
265 // Prepare the template engine for the current template
266 $tplEngine = $this->prepareTemplateEngine($appInstance);
268 // Try to load the web template
269 $tplEngine->loadWebTemplate(sprintf("%s_%s",
270 $this->getConfigInstance()->readConfig('tpl_selector_prefix'),
271 strtolower($appInstance->getAppShortName())
274 // Remember this template and the application for later usage
275 $this->loadedTemplates->append(array(
276 'tpl_engine' => $tplEngine,
277 'app_instance' => $appInstance
281 // Re-initialize the application list to avoid double loading
282 $this->initializeAppsList();
286 * Removes $dirIgnoreList from the object to save some memory
290 public final function removeDirIgnoreList () {
291 unset($this->dirIgnoreList);
295 * Loads the selector's own main template. This step is not linking the
296 * application's templates into the main one.
300 public function loadSelectorTemplate () {
301 // Prepare the template engine
302 $tplEngine = $this->prepareTemplateEngine($this);
304 // Load the selector's template
305 $tplEngine->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_main_tpl'));
307 // Now store it in the class
308 $this->setSelectorTemplateEngine($tplEngine);
312 * Inserts all loaded application templates into the selector's template
315 * @throws NullPointerException If $curr is null
316 * @throws NoArrayException If $curr is not an array
317 * @throws InvalidArrayCountException If $curr contains an
318 * unexpected count of elements
319 * @throws MissingArrayElementsException If $curr is missing expected
322 public function insertApplicationTemplates () {
323 // First prepare the instance
324 $tplEngine = $this->prepareTemplateEngine($this);
326 // Load template which shall later hold all application templates
327 $tplEngine->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_apps_tpl'));
329 // Add all loaded application templates together
331 for ($idx = $this->getLoadedTemplates()->getIterator(); $idx->valid(); $idx->next()) {
332 // Get current item from array object
333 $curr = $idx->current();
335 // Do some sanity checks on the loaded item
336 if (is_null($curr)) {
338 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
339 } elseif (!is_array($curr)) {
341 throw new NoArrayException($curr, self::EXCEPTION_IS_NO_ARRAY);
342 } elseif (count($curr) != 2) {
343 // Not expected count of entries
344 throw new InvalidArrayCountException(array($this, "curr", count($curr), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
345 } elseif (!isset($curr['tpl_engine']) || (!isset($curr['app_instance']))) {
346 // Expected entries missing
347 throw new MissingArrayElementsException(array($this, "curr", array('tpl_engine', 'app_instance')), self::EXCEPTION_ARRAY_ELEMENTS_MISSING);
349 die("<pre>".print_r($curr, true)."</pre>");