X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;fp=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;h=0000000000000000000000000000000000000000;hb=bc5ab6fca061052ad58261118d8f8b38bf10ebbd;hp=e3202603aba1317a735a0bfbf02dcc37b2206f3a;hpb=7940f3ad709afe4ba58012aa835c82cecc9328cc;p=mailer.git diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php deleted file mode 100644 index e3202603ab..0000000000 --- a/inc/config/class_FrameworkConfiguration.php +++ /dev/null @@ -1,272 +0,0 @@ - - * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software - * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ -class FrameworkConfiguration implements Registerable { - /** - * The framework's main configuration array which will be initialized with - * hard-coded configuration data and might be overwritten/extended by - * config data from the database. - */ - private $config = array(); - - /** - * The configuration instance itself - */ - 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 constructor - * - * @return void - */ - protected function __construct () { - // Empty for now - } - - /** - * Getter for an instance of this class - * - * @return $cfgInstance An instance of this class - */ - 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; - } - - /** - * Setter for default time zone (must be correct!) - * - * @param $zone The time-zone string (e.g. Europe/Berlin) - * @return void - */ - 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 - } - - /** - * Setter for runtime magic quotes - */ - public final function setMagicQuotesRuntime ($enableQuotes) { - // Cast it to boolean - $enableQuotes = (boolean) $enableQuotes; - - // Set it - @set_magic_quotes_runtime($enableQuotes); - } - - /** - * A private include loader - * - * @param $arrayObject The array object with all include files - * @return void - */ - 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 - } - - /** - * Read a configuration element. - * - * @param $cfgEntry The configuration element - * @return $cfgValue The fetched configuration value - * @throws ConfigEntryIsEmptyException If $cfgEntry is empty - * @throws ConfigEntryNotFoundException If a configuration element - * was not found - */ - 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.
\n"; - } // END - if - - // Return the requested value - return $this->config[$cfgEntry]; - } - - /** - * Set a configuration entry. - * - * @param $cfgEntry The configuration entry we want to add/change - * @param $cfgValue The configuration value we want to set - * @return void - * @throws ConfigEntryIsEmptyException If $cfgEntry is empty - */ - 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); - } - - /** - * Compatiblity method to return this class' name - * - * @return __CLASS__ This class' name - */ - public function __toString () { - return get_class($this); - } - - /** - * Dectect and return the base URL for all URLs and forms - * - * @return $baseUrl Detected base URL - */ - 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; - } - - /** - * Detect safely and return the full domain where this script is installed - * - * @return $fullDomain The detected full domain - */ - 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; - } - - /** - * Detect safely the script path without trailing slash which is the part - * between "http://your-domain.invalid/" and "script-name.php" - */ - 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; - } - - /** - * Getter for field name - * - * @param $fieldName Field name which we shall get - * @return $fieldValue Field value from the user - */ - function getField ($fieldName) { - // Dummy method! - } - - /** - * Updates a given field with new value - * - * @param $fieldName Field to update - * @param $fieldValue New value to store - * @return void - */ - public function updateDatabaseField ($fieldName, $fieldValue) { - // Dummy method! - } -} - -// [EOF] -?>