Source for file GlobalConfig.php

Documentation is available at GlobalConfig.php

  1. <?php
  2. /**
  3.  * Teeple2 - PHP5 Web Application Framework inspired by Seasar2
  4.  *
  5.  * PHP versions 5
  6.  *
  7.  * LICENSE: This source file is subject to version 3.0 of the PHP license
  8.  * that is available through the world-wide-web at the following URI:
  9.  * http://www.php.net/license/3_0.txt.  If you did not receive a copy of
  10.  * the PHP License and are unable to obtain it through the web, please
  11.  * send a note to license@php.net so we can mail you a copy immediately.
  12.  *
  13.  * @package     teeple
  14.  * @author      Mitsutaka Sato <miztaka@gmail.com>
  15.  * @license     http://www.php.net/license/3_0.txt  PHP License 3.0
  16.  */
  17.  
  18. /**
  19.  * GlobalConfig
  20.  * 
  21.  * プログラム全体の設定情報を扱うためのクラス
  22.  * PHPの定数を透過的に扱うことが出来る
  23.  * 
  24.  * preferConstantによってPHP定数の優先順位が変わる
  25.  * trueにすると
  26.  *   PHP定数 > setValueで設定された値 > importSectionsでまとめて読み込んだ値
  27.  * falseにすると
  28.  *   setValueで設定された値 > importSectionsでまとめて読み込んだ値 > PHP定数
  29.  * 
  30.  * @package     teeple
  31.  */
  32. class Teeple_GlobalConfig
  33. {
  34.     /**
  35.      * @var  array  importSectionsで読み込まれた設定値が保存される
  36.      */
  37.     var $_values = array();
  38.  
  39.     /**
  40.      * @var  String  setValueで設定された値が保存される
  41.      */
  42.     var $_overwriteValues = array();
  43.     
  44.     /**
  45.      * @var  String  importSectionsで読み込んだ値を、セクション単位でまとめるための配列
  46.      */
  47.     var $_sections = array();
  48.  
  49.     /**
  50.      * @var  String  定数としてエクスポート可能な名前を表す正規表現
  51.      */
  52.     var $_exportableConstPattern = '/^[A-Z_][A-Z0-9_]*$/';
  53.  
  54.     /**
  55.      * @var  String  定数を他の値に対して優先するか否か
  56.      */
  57.     var $_preferConstant = false;
  58.  
  59.     /**
  60.      * コンストラクタ
  61.      * 
  62.      * @access public
  63.      * @param bool $preferConstant  [optional] if true, constants have priority over
  64.      *                                          any other values.
  65.      */
  66.     function __construct($preferConstant=false)
  67.     {
  68.         $this->_preferConstant = $preferConstant;
  69.     }
  70.  
  71.     /**
  72.      * 定数を優先するか
  73.      * 
  74.      * @access public
  75.      * @param  boolean    $bool 
  76.      */
  77.     function setPreferConstant($bool)
  78.     {
  79.         $this->_preferConstant = $bool;
  80.     }
  81.  
  82.     /**
  83.      * 値がsetValueメソッドによって上書きされているか
  84.      * どうかを調べる
  85.      * 
  86.      * @access private
  87.      * @param  String    $key 
  88.      * @return boolean 
  89.      * @see    setValue()
  90.      */
  91.     function _isOverwritten($key)
  92.     {
  93.         return array_key_exists($key, $this->_overwriteValues);
  94.     }
  95.  
  96.     /**
  97.      * 定数が利用可能かどうかを調べる
  98.      * 
  99.      * @access private
  100.      * @param  String    $key 
  101.      * @return boolean 
  102.      */
  103.     function _canUseConstant($key)
  104.     {
  105.         return defined($key);
  106.     }
  107.  
  108.     /**
  109.      * 配列を一括して取り込む
  110.      * 自動的にupdateValuesを呼び出し、保持されている値を更新する
  111.      * 
  112.      * @access public
  113.      * @param  array    $arr 
  114.      */
  115.     function importSections($arr)
  116.     {
  117.         $this->_sections = $arr + $this->_sections;
  118.         $this->updateValues();
  119.     }
  120.  
  121.  
  122.     /**
  123.      * 保持されている値を更新する
  124.      * 
  125.      * @access public
  126.      */
  127.     function updateValues()
  128.     {
  129.         foreach($this->_sections as $sec => $arr) {
  130.             $prefix = $this->getValue($sec, "");
  131.             
  132.             foreach($arr as $k => $v) {
  133.                 $this->_values[$k] = $prefix . $v;
  134.             }
  135.         }
  136.     }
  137.  
  138.     /**
  139.      * 設定値を得る
  140.      * 定数として宣言されているか、
  141.      * 定数を優先するか、
  142.      * 上書きされているか、
  143.      * 等の要素を考慮して設定値は決まる
  144.      * 
  145.      * @access public
  146.      * @param  String    $key 
  147.      * @param  mixed    $default 
  148.      * @return mixed 
  149.      */
  150.     function getValue($key, $default=null)
  151.     {
  152.         if($this->_preferConstant && $this->_canUseConstant($key)) {
  153.             return constant($key);
  154.             
  155.         } elseif($this->_isOverwritten($key)) {
  156.             return $this->_overwriteValues[$key];
  157.             
  158.         } elseif(isset($this->_values[$key])) {
  159.             return $this->_values[$key];
  160.             
  161.         } elseif(!$this->_preferConstant && $this->_canUseConstant($key)) {
  162.             return constant($key);
  163.             
  164.         }
  165.         return $default;
  166.     }
  167.  
  168.     /**
  169.      * 値が設定されているかどうかを調べる
  170.      * 
  171.      * @access public
  172.      * @param  String    $key 
  173.      * @param  boolean    $checkConst [optional] 定数をチェックするか
  174.      * @return boolean 
  175.      */
  176.     function hasValue($key, $checkConst=false)
  177.     {
  178.         return ($this->_isOverwritten($key) ||
  179.            isset($this->_values[$key]) ||
  180.            ($checkConst && $this->_canUseConstant($key)));
  181.     }
  182.  
  183.     /**
  184.      * 値を設定する
  185.      * このメソッドで設定した値は
  186.      * $_overwriteValuesとして独自に管理される
  187.      * 
  188.      * @access public
  189.      * @param  mixed    $key 
  190.      * @param  mixed    $value 
  191.      * @param  boolean  $autoUpdate [optional]
  192.      *                   if ture, call updateValues() after overwriting
  193.      */
  194.     function setValue($key, $value, $autoUpdate=false)
  195.     {
  196.         $this->_overwriteValues[$key] = $value;
  197.         if($autoUpdate) {
  198.             $this->updateValues();
  199.         }
  200.     }
  201.  
  202.     /**
  203.      * セクション単位で設定値を配列の形で得る
  204.      * 
  205.      * @access public
  206.      * @param  String    $sec 
  207.      * @return array 
  208.      */
  209.     function getSection($sec)
  210.     {
  211.         if(!isset($this->_sections[$sec])) {
  212.             return null;
  213.         }
  214.         
  215.         $result = array();
  216.         foreach($this->_sections[$sec] as $k => $v) {
  217.             if($this->_isOverwritten($k) ||
  218.                ($this->_preferConstant && $this->_canUseConstant($k))) {
  219.                 //上書きされているか、
  220.                 //定数として独自に定義されている場合は、
  221.                 //セクション内に含めない
  222.                 continue;
  223.             } else {
  224.                 $result[$k] = $this->getValue($k);
  225.             }
  226.         }
  227.         return $result;
  228.     }
  229.  
  230.     /**
  231.      * INIファイルから設定を読み込む
  232.      * 
  233.      * @access public
  234.      * @param  String    $filename 
  235.      * @return boolean 
  236.      */
  237.     function loadFromFile($filename)
  238.     {
  239.         if (defined('INI_SCANNER_RAW')) {
  240.             $arr = @parse_ini_file($filename, true, INI_SCANNER_RAW);
  241.         } else {
  242.             $arr = @parse_ini_file($filename, true);
  243.         }
  244.         if(! $arr) {
  245.             throw new Teeple_Exception("iniファイルの読み込みに失敗しました。");
  246.         }
  247.         $this->importSections($arr);
  248.         return true;
  249.     }
  250.  
  251.     /**
  252.      * 設定値を定数としてエクスポートする
  253.      * 
  254.      * @access public
  255.      * @return String 
  256.      */
  257.     function exportConstants()
  258.     {
  259.         $allValues = $this->_overwriteValues + $this->_values;
  260.         foreach($allValues as $k => $v) {
  261.             if(!defined($k) && $this->isConstName($k)) {
  262.                 define($k, $v);
  263.             }
  264.         }
  265.     }
  266.  
  267.     /**
  268.      * 定数としてエクスポート可能な名称か調べる
  269.      * 
  270.      * @access public
  271.      * @param  String    $key 
  272.      * @return String 
  273.      */
  274.     function isConstName($key)
  275.     {
  276.         return preg_match($this->_exportableConstPattern, $key);
  277.     }
  278.  
  279.     /**
  280.      * ファイルから設定を読み込み、
  281.      * 定数としてのエクスポートまでを行うstaticメソッド
  282.      * 
  283.      * @static
  284.      * @access public
  285.      * @return boolean 
  286.      */
  287.     function loadConstantsFromFile($filename)
  288.     {
  289.         $config = new Teeple_GlobalConfig(true);
  290.         if(!$config->loadFromFile($filename)) {
  291.             return false;
  292.         }
  293.         $config->exportConstants();
  294.     }
  295.  
  296. }
  297.  
  298. ?>
Documentation generated on Mon, 26 Apr 2010 08:59:50 +0900 by phpDocumentor 1.4.3