Source for file basicconfigreader.php

Documentation is available at basicconfigreader.php

  1. <?php
  2. /**
  3. * Generic configuration management object
  4. *
  5. * Parses the {@link bumblebee.ini } file
  6. *
  7. * @author    Stuart Prescott
  8. * @copyright  Copyright Stuart Prescott
  9. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  10. * @version    $Id: basicconfigreader.php,v 1.13 2007/02/16 23:10:19 themill Exp $
  11. * @package    Bumblebee
  12. * @subpackage Misc
  13. */
  14.  
  15. /** Load ancillary functions */
  16. require_once 'inc/typeinfo.php';
  17. checkValidInclude();
  18.  
  19. if (version_compare(PHP_VERSION, "5") >= 0) {
  20.   // Conditionally include the singleton functions if PHP5 is being used
  21.     require_once 'inc/bb/basicconfigreadersingleton_php5.php';
  22.  
  23. } else {
  24.   // pull in the singleton file and translate the PHP5 to PHP4 (that is still known to work)
  25.     $file = file_get_contents('inc/bb/basicconfigreadersingleton_php5.php', true);
  26.   $file = preg_replace(
  27.             array('@static function@', '@<\?php@', '@\?>@'),
  28.             array('function',          '',         ''),
  29.             $file);
  30.   eval($file);
  31. }
  32.  
  33. class BasicConfigReader extends BasicConfigReaderSingleton {
  34.  
  35.   var $data;
  36.  
  37.   var $configError = false;
  38.  
  39.   var $configFileLocation = null;
  40.  
  41.   function BasicConfig() {
  42.     parent::BasicConfigReaderSingleton();
  43.   }
  44.  
  45.   function SetFileLocation($directory) {
  46.     $this->configFileLocation = $directory;
  47.   }
  48.  
  49.   function LoadFile($filename, $fatalErrors=true) {
  50.     $this->data = $this->_readConfigFile($filename, $fatalErrors);
  51.   }
  52.  
  53.   function MergeFile($filename, $section=null, $fatalErrors=true) {
  54.     $newdata = $this->_readConfigFile($filename, $fatalErrors);
  55.     $this->mergeConfig($newdata, $section);
  56.   }
  57.  
  58.   function _readConfigFile($filename, $fatalErrors=true) {
  59.     $source = $this->configFileLocation . DIRECTORY_SEPARATOR . $filename;
  60.     if (! file_exists($source) && file_exists($filename)) {
  61.       $this->configError = true;
  62.       trigger_error("System misconfiguration: I could fine the config file '$filename' but
  63.       not in the designated location.", $fatalErrors ? E_USER_ERROR : E_USER_NOTICE);
  64.     } elseif (! file_exists($source)) {
  65.       $this->configError = true;
  66.       trigger_error("System misconfiguration: I could not find the config file '$filename'. Please give me a config file so I can do something useful.", $fatalErrors ? E_USER_ERROR : E_USER_NOTICE);
  67.     }
  68.     $newdata = parse_ini_file($source, 1);
  69.     if (! is_array($newdata)) {
  70.       // if the config file doesn't exist, then we're pretty much stuffed
  71.       $this->configError = true;
  72.       trigger_error("System misconfiguration: I could not find the config file '$filename'. Please give me a config file so I can do something useful.", $fatalErrors ? E_USER_ERROR : E_USER_NOTICE);
  73.     }
  74.     return $newdata;
  75.   }
  76.  
  77.   function value($section, $parameter, $default=null) {
  78.     if (isset($this->data[$section]) && is_array($this->data[$section])) {
  79.       return issetSet($this->data[$section], $parameter, $default);
  80.     } else {
  81.       return $default;
  82.     }
  83.   }
  84.  
  85.   function getSection($section) {
  86.     if(isset($this->data[$section]) && is_array($this->data[$section])) {
  87.       return $this->data[$section];
  88.     } else {
  89.       trigger_error("Tried to access non existent section");
  90.     }
  91.   }
  92.  
  93.   function getSections() {
  94.     return array_keys($this->data);
  95.   }
  96.  
  97.   /** merge an array into the config data. If a section is provided the array is added as a new sub key */
  98.   function mergeConfig($other_array, $section = null) {
  99.     if(is_array($other_array)) {
  100.       if($section == null) {
  101.         $this->data = array_merge($this->data, $other_array);
  102.       } else if(!isset($this->data[$section])) {
  103.         $this->data = array_merge($this->data, array($section => $other_array));
  104.       } else {
  105.         $tmp = $this->data[$section];
  106.         $tmp = array_merge($tmp, $other_array);
  107.         $this->data[$section] = $tmp;
  108.       }
  109.     } else {
  110.       trigger_error("Tried to merge a non array into the config values");
  111.     }
  112.   }
  113.  
  114.   function mergeDatabaseTable($table = 'settings', $sectionColumn = 'section',
  115.                               $parameterColumn = 'parameter', $valueColumn = 'value') {
  116.     global $TABLEPREFIX;
  117.     $q = "SELECT $sectionColumn as section, $parameterColumn as parameter, $valueColumn as value from $TABLEPREFIX$table";
  118.     $sql = db_get($q, false);
  119.     while ($g = db_fetch_array($sql)) {
  120.       if (! isset($this->data[$g['section']]) || ! is_array($this->data[$g['section']])) {
  121.         $this->data[$g['section']] = array();
  122.       }
  123.       $this->data[$g['section']][$g['parameter']] = $g['value'];
  124.       //printf('[%s]::$s = %s', $g['section'], $g['parameter'], $g['value']);
  125.     }
  126.   }
  127.  
  128. }
  129.  
  130.  
  131. ?>

Documentation generated on Tue, 06 Mar 2007 10:00:40 +0000 by phpDocumentor 1.3.0