ZF Zend Framework

Behind the Site

Programmer's Reference Guide

Zend_Config_Ini
Zend_Config
プログラマ向けリファレンスガイド

Zend_Config_Xml

Zend_Config_Xml を使用すると、シンプルな XML 形式で保存した設定データを、オブジェクトのプロパティとして扱えるようになります。 XML ファイルあるいは文字列のルート要素は設定には関係しないので、任意の名前がつけられます。 その直下のレベルの XML 要素が設定データのセクションに対応します。 セクションレベルの要素の下に XML 要素を配置することで、 階層構造をサポートします。 末端レベルの XML 要素が設定データの値に対応します。 セクションの継承は、XML の属性 extends でサポートされます。この属性の値が、 データを継承しているセクション名を表します。

注意: 返り値の型
 Zend_Config_Xml で読み込んだ設定データは、 常に文字列形式で返されます。必要に応じて、 文字列から適切な型に変換してください。

例1 Zend_Config_Xml の使用法

この例は、Zend_Config_Xml を使用して XML ファイルから設定データを読み込むための基本的な方法を説明するものです。 この例では、運用環境の設定と開発環境の設定を両方管理しています。 開発環境用の設定データは運用環境用のものと非常に似ているので、 開発環境用のセクションは運用環境用のセクションを継承させています。 今回の場合なら、逆に運用環境用のセクションを開発環境用のものから継承させてもいいでしょう。 そうしたからといって特に状況が複雑になるわけではありません。 ここでは、次のような内容の設定データが /path/to/config.xml に存在するものとします。

  1. <?xml version="1.0"?>
  2. <configdata>
  3.     <production>
  4.         <webhost>www.example.com</webhost>
  5.         <database>
  6.             <adapter>pdo_mysql</adapter>
  7.             <params>
  8.                 <host>db.example.com</host>
  9.                 <username>dbuser</username>
  10.                 <password>secret</password>
  11.                 <dbname>dbname</dbname>
  12.             </params>
  13.         </database>
  14.     </production>
  15.     <staging extends="production">
  16.         <database>
  17.             <params>
  18.                 <host>dev.example.com</host>
  19.                 <username>devuser</username>
  20.                 <password>devsecret</password>
  21.             </params>
  22.         </database>
  23.     </staging>
  24. </configdata>

次に、開発者が開発環境用の設定データを XML ファイルから読み込むことを考えます。 これは簡単なことで、単に XML ファイルとセクションを指定するだけです。

  1. $config = new Zend_Config_Xml('/path/to/config.xml', 'staging');
  2.  
  3. echo $config->database->params->host;   // "dev.example.com" と出力します
  4. echo $config->database->params->dbname; // "dbname" と出力します

例2 Zend_Config_Xml におけるタグの属性の使用

Zend_Config_Xml では、設定内でノードを定義する際にさらに 2 通りの方法を用意しています。 どちらも属性を使用するものです。extends 属性や value 属性は予約語 (後者は、属性を使う 2 番目の方法で使用します) となり、使用できません。属性を使用する方法のひとつは、 親ノードに属性を追加するものです。 これが、そのノードの子と見なされます。

  1. <?xml version="1.0"?>
  2. <configdata>
  3.     <production webhost="www.example.com">
  4.         <database adapter="pdo_mysql">
  5.             <params host="db.example.com" username="dbuser" password="secret" dbname="dbname"/>
  6.         </database>
  7.     </production>
  8.     <staging extends="production">
  9.         <database>
  10.             <params host="dev.example.com" username="devuser" password="devsecret"/>
  11.         </database>
  12.     </staging>
  13. </configdata>

もうひとつの方法は、設定ファイルの記述量を減らすことはありません。 ただ、同じタグ名を何度も書く必要がなくなるので保守性は上がります。 単純に空のタグを作成し、その値を value 属性に含めます。

  1. <?xml version="1.0"?>
  2. <configdata>
  3.     <production>
  4.         <webhost>www.example.com</webhost>
  5.         <database>
  6.             <adapter value="pdo_mysql"/>
  7.             <params>
  8.                 <host value="db.example.com"/>
  9.                 <username value="dbuser"/>
  10.                 <password value="secret"/>
  11.                 <dbname value="dbname"/>
  12.             </params>
  13.         </database>
  14.     </production>
  15.     <staging extends="production">
  16.         <database>
  17.             <params>
  18.                 <host value="dev.example.com"/>
  19.                 <username value="devuser"/>
  20.                 <password value="devsecret"/>
  21.             </params>
  22.         </database>
  23.     </staging>
  24. </configdata>

注意: XML 文字列
 Zend_Config_Xml は、データベースなどから取得した XML 文字列を直接読み込むこともできます。 文字列はコンストラクタの最初のパラメータとして渡し、最初は '<?xml' で始まらなければなりません。

  1. $string = <<<EOT
  2. <?xml version="1.0"?>
  3. <config>
  4.     <production>
  5.         <db>
  6.             <adapter value="pdo_mysql"/>
  7.             <params>
  8.                 <host value="db.example.com"/>
  9.             </params>
  10.         </db>
  11.     </production>
  12.     <staging extends="production">
  13.         <db>
  14.             <params>
  15.                 <host value="dev.example.com"/>
  16.             </params>
  17.         </db>
  18.     </staging>
  19. </config>
  20. EOT;
  21.  
  22. $config = new Zend_Config_Xml($string, 'staging');

Zend_Config_Ini
Zend_Config
プログラマ向けリファレンスガイド
blog comments powered by Disqus

Select a Version

Languages Available

Components

Search the Manual

    • Navigation