class_ApplicationSelector.php

Go to the documentation of this file.

<?php
class ApplicationSelector extends BaseFrameworkSystem {
        private $foundApps = null;

        private $loadedTemplates = null;

        private $dirIgnoreList = array(
                ".",
                "..",
                ".htaccess",
                ".svn"
        );

        protected function __construct() {
                // Call parent constructor
                parent::__construct(__CLASS__);

                // Remove system array and thousand seperator
                $this->removeSystemArray();
                $this->removeNumberFormaters();

                // Initialize the array lists
                $this->initializeAppsList();
                $this->initializeTemplatesList();
        }

        public final static function createApplicationSelector (ManageableLanguage $langInstance, FileIoHandler $fileIOInstance) {
                // Get a new instance
                $selInstance = new ApplicationSelector();

                // Get all applications
                $selInstance->readApplicationDirectory();

                // Set language and file I/O instances
                $selInstance->setLanguageInstance($langInstance);
                $selInstance->setFileIoInstance($fileIOInstance);

                // Return the prepared instance
                return $selInstance;
        }

        private function initializeAppsList () {
                $this->foundApps = new FrameworkArrayObject("FakedFoundApplications");
        }

        private function initializeTemplatesList () {
                $this->loadedTemplates = new FrameworkArrayObject("FakedLoadedTemplates");
        }

        private function loadApplicationData ($appData, $appName) {
                // Is it a file and readable?
                if ((is_file($appData)) && (is_readable($appData))) {
                        // Then include it
                        include ($appData);

                        // Add the current instance to the list
                        $this->foundApps->append($app);
                } // END - if ((is_file(...
        }

        private final function getLoadedTemplates () {
                return $this->loadedTemplates;
        }

        public function getAppShortName() {
                $shortName = $this->getConfigInstance()->readConfig('selector_path');
                return $shortName;
        }

        public function addDirIgnoreList ($ignoreItem) {
                // Cast and add it
                $this->dirIgnoreList[] = (string) $ignoreItem;
        }

        public function readApplicationDirectory () {
                // Generate the base path for all applications
                $appBasePath = $this->getConfigInstance()->readConfig('application_path');

                // Add the selector path to the ignore list
                $this->addDirIgnoreList($this->getConfigInstance()->readConfig('selector_path'));

                // Get a directory pointer for the application path
                $dirInstance = FrameworkDirectoryPointer::createFrameworkDirectoryPointer($appBasePath);

                // Read all directories&files except some parts
                while ($appName = $dirInstance->readDirectoryExcept($this->dirIgnoreList)) {
                        // Generate FQFN for the application name (or better directory name)
                        $fqfn = sprintf("%s%s", $appBasePath, $appName);

                        // Is this a readable directory? (files will be ignored silently)
                        if ((is_dir($fqfn)) && (is_readable($fqfn))) {
                                // Then get the data.php script for analyzing
                                $appData = sprintf("%s/data.php", $fqfn);

                                // Load the application's data.php script and append the
                                // application to the ArrayObject
                                $this->loadApplicationData($appData, $appName);
                        } // END - if
                } // END - while

                // Close directory pointer
                $dirInstance->closeDirectory();
        }

        public function loadApplicationTemplates () {
                // Iterate through all applications
                for ($idx = $this->foundApps->getIterator(); $idx->valid(); $idx->next()) {
                        // Get current application
                        $appInstance = $idx->current();

                        // Prepare the template engine for the current template
                        $templateInstance = $this->prepareTemplateInstance($appInstance);

                        // Try to load the web template
                        $templateInstance->loadWebTemplate(sprintf("%s_%s",
                                $this->getConfigInstance()->readConfig('tpl_selector_prefix'),
                                strtolower($appInstance->getAppShortName())
                        ));

                        // Remember this template and the application for later usage
                        $this->loadedTemplates->append(array(
                                'template_class'   => $templateInstance,
                                'app_instance' => $appInstance
                        ));
                }

                // Re-initialize the application list to avoid double loading
                $this->initializeAppsList();
        }

        public final function removeDirIgnoreList () {
                unset($this->dirIgnoreList);
        }

        public function loadSelectorTemplate () {
                // Prepare the template engine
                $templateInstance = $this->prepareTemplateInstance($this);

                // Load the selector's template
                $templateInstance->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_main_tpl'));

                // Now store it in the class, we need this later on final compilation of available applications
                $this->setTemplateInstance($templateInstance);
        }

        public function insertApplicationTemplates () {
                // First prepare the instance
                $templateInstance = $this->prepareTemplateInstance($this);

                // Load template which shall later hold all application templates
                $templateInstance->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_apps_tpl'));

                // Add all loaded application templates together
                $dummy = "";
                for ($idx = $this->getLoadedTemplates()->getIterator(); $idx->valid(); $idx->next()) {
                        // Get current item from array object
                        $curr = $idx->current();

                        // Do some sanity checks on the loaded item
                        if (is_null($curr)) {
                                // $curr is null
                                throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
                        } elseif (!is_array($curr)) {
                                // Not an array
                                throw new NoArrayException($curr, self::EXCEPTION_IS_NO_ARRAY);
                        } elseif (count($curr) != 2) {
                                // Not expected count of entries
                                throw new InvalidArrayCountException(array($this, "curr", count($curr), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
                        } elseif (!isset($curr['template_class']) || (!isset($curr['app_instance']))) {
                                // Expected entries missing
                                throw new MissingArrayElementsException(array($this, "curr", array("template_class", "app_instance")), self::EXCEPTION_ARRAY_ELEMENTS_MISSING);
                        }

                        // Debug output
                        die(__METHOD__."()<pre>".print_r($curr, true)."</pre>");
                } // END - for
        }
}

// [EOF]
?>