class_FrameworkConfiguration.php

Go to the documentation of this file.

<?php
class FrameworkConfiguration implements Registerable {
        private $config = array();

        private static $cfgInstance = null;

        // Some constants for the configuration system
        const EXCEPTION_CONFIG_ENTRY_IS_EMPTY      = 0x130;
        const EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND = 0x131;

        protected function __construct () {
                // Empty for now
        }

        public final static function getInstance () {
                // is the instance there?
                if (is_null(self::$cfgInstance))  {
                        // Create a config instance
                        self::$cfgInstance = new FrameworkConfiguration();
                } // END - if

                return self::$cfgInstance;
        }

        public final function setDefaultTimezone ($zone) {
                // At least 5.1.0 is required for this!
                if (version_compare(phpversion(), "5.1.0")) {
                        @date_default_timezone_set($zone);
                } // END - if
        }

        public final function setMagicQuotesRuntime ($enableQuotes) {
                // Cast it to boolean
                $enableQuotes = (boolean) $enableQuotes;

                // Set it
                @set_magic_quotes_runtime($enableQuotes);
        }

        private function loadIncludes (ArrayObject $arrayObject) {
                // Load only if there are includes defined
                if (!is_null($arrayObject)) {
                        for ($idx = $arrayObject->getIterator(); $idx->valid(); $idx->next()) {
                                // Get include file
                                $inc = $idx->current();

                                // Is the file name really set?
                                if (!empty($inc)) {
                                        // Base path is by default added
                                        $fqfn = $inc;

                                        // Base path added? (Uni* / Windows)
                                        if ((substr($inc, 0, 1) != "/") && (substr($inc, 1, 1) != ":")) {
                                                // Generate FQFN
                                                $fqfn = sprintf("%s/inc/extra/%s", $this->readConfig('base_path'), $inc);
                                        } // END - if
                                } // END - if

                                // Include them all here
                                require($fqfn);
                        }
                } // END - if
        }

        public function readConfig ($cfgEntry) {
                // Cast to string
                $cfgEntry = (string) $cfgEntry;

                // Is a valid configuration entry provided?
                if (empty($cfgEntry)) {
                        // Entry is empty
                        throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
                } elseif (!isset($this->config[$cfgEntry])) {
                        // Entry was not found!
                        throw new ConfigEntryNotFoundException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
                }

                // Debug message
                if ((defined('DEBUG_CONFIG')) || (defined('DEBUG_ALL'))) {
                        echo "[".__METHOD__."] Configuration entry ".$cfgEntry." requested.<br />\n";
                } // END - if

                // Return the requested value
                return $this->config[$cfgEntry];
        }

        public final function setConfigEntry ($cfgEntry, $cfgValue) {
                // Cast to string
                $cfgEntry = (string) $cfgEntry;
                $cfgValue = (string) $cfgValue;

                // Is a valid configuration entry provided?
                if (empty($cfgEntry)) {
                        // Entry is empty
                        throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
                } // END - if

                // Set the configuration value
                $this->config[$cfgEntry] = $cfgValue;

                // Resort the array
                ksort($this->config);
        }

        public function __toString () {
                return get_class($this);
        }

        public function detectBaseUrl() {
                // Initialize the URL
                $baseUrl = "http";

                // Do we have HTTPS?
                if (isset($_SERVER['HTTPS'])) {
                        // Add the >s< for HTTPS
                        $baseUrl .= "s";
                } // END - if

                // Construct the full URL now and secure it against CSRF attacks
                $baseUrl = $baseUrl . "://" . $this->detectDomain() . $this->detectScriptPath();

                // Return the URL
                return $baseUrl;
        }

        public function detectDomain () {
                // Full domain is localnet.invalid by default
                $fullDomain = "localnet.invalid";

                // Is the server name there?
                if (isset($_SERVER['SERVER_NAME'])) {
                        // Detect the full domain
                        $fullDomain = htmlentities(strip_tags($_SERVER['SERVER_NAME']), ENT_QUOTES);
                } // END - if

                // Return it
                return $fullDomain;
        }

        public function detectScriptPath () {
                // Default is empty
                $scriptPath = "";

                // Is the scriptname set?
                if (isset($_SERVER['SCRIPT_NAME'])) {
                        // Get dirname of it
                        $scriptPath = dirname($_SERVER['SCRIPT_NAME']);
                } // END - if

                // Return it
                return $scriptPath;
        }

        function getField ($fieldName) {
                // Dummy method!
        }

        public function updateDatabaseField ($fieldName, $fieldValue) {
                // Dummy method!
        }
}

// [EOF]
?>