Programmer's Reference Guide
| Zend_Config_Writer |
Zend_Config_Writer
Zend_Config_Writer は、設定ファイルに Zend_Config オブジェクトを書き出します。 アダプタなしでも動作するので、使用するのも簡単です。 デフォルトでは Zend_Config_Writer には 3 種類のアダプタが同梱されており、どれも同じように動作します。 まず、filename や config のオプションを指定してライターのインスタンスを作成します。 それからライターの write() メソッドをコールすると、 設定ファイルが作成されます。$filename や $config を、直接 write() メソッドで設定することもできます。現在は、次のライターが Zend_Config_Writer に同梱されています。
-
Zend_Config_Writer_Array
-
Zend_Config_Writer_Ini
-
Zend_Config_Writer_Xml
例外的に、Zend_Config_Writer_Ini にはオプションのパラメータ nestSeparator が用意されています。 これは、ノードを区切る文字を定義します。デフォルトはドットひとつで、 これは Zend_Config_Ini のデフォルトと同じです。
Zend_Config オブジェクトを変更したり作成したりする際には、 知っておくべきことがあります。値を作成したり変更したりするには、 パラメータのアクセサ (->) で Zend_Config オブジェクトのパラメータを設定します。 ルート内のセクションやブランチを作成するには、新規配列を作成します ("$config->branch = array();")。 セクションの継承関係を定義するには、ルート Zend_Config オブジェクトの setExtend() メソッドをコールします。
例1 Zend_Config_Writer の使用法
この例では、Zend_Config_Writer_Xml で新しい設定ファイルを作成する方法を説明します。
- // config オブジェクトを作成します
- $config->setExtend('staging', 'production');
- $config->production->db->hostname = 'localhost';
- $config->production->db->username = 'production';
- $config->staging->db->username = 'staging';
- // 次のいずれかの方法で設定ファイルを書き出します
- // a)
- 'filename' => 'config.xml'));
- $writer->write();
- // b)
- $writer = new Zend_Config_Writer_Xml();
- $writer->setConfig($config)
- ->setFilename('config.xml')
- ->write();
- // c)
- $writer = new Zend_Config_Writer_Xml();
- $writer->write('config.xml', $config);
これは、production と staging というセクションを持つ XML 設定ファイルを作成します。staging は production を継承しています。
例2 既存の設定の変更
この例では、既存の設定ファイルを編集する方法を説明します。
- // すべてのセクションを既存の設定ファイルから読み込みますが継承は読み飛ばします
- $config = new Zend_Config_Ini('config.ini',
- null,
- 'allowModifications' => true));
- // 値を変更します
- $config->production->hostname = 'foobar';
- // 設定ファイルを書き出します
- 'filename' => 'config.ini'));
- $writer->write();
注意: 設定ファイルの読み込み
既存の設定ファイルを読み込んで変更をする場合は、 すべてのセクションを読み込んで継承を読み飛ばすことが大切です。 そうすることで、値がマージされてしまうことがなくなります。 そのために、コンストラクタで skipExtends オプションを指定します。
| Zend_Config_Writer |