Documentation

Zend_Config_Writer(日本語) - Zend_Config_Writer

Zend_Config_Writer(日本語)

Zend_Config_Writer は、設定ファイルに Zend_Config オブジェクトを書き出します。 アダプタなしでも動作するので、使用するのも簡単です。 デフォルトでは Zend_Config_Writer には 4 種類のアダプタが同梱されており、全てファイル・ベースです。 まず、filenameconfig のオプションを指定してライターのインスタンスを作成します。 それからライターの write() メソッドをコールすると、 設定ファイルが作成されます。$filename$config を、直接 write() メソッドで設定することもできます。現在は、次のライターが Zend_Config_Writer に同梱されています。

  • Zend_Config_Writer_Array

  • Zend_Config_Writer_Ini

  • Zend_Config_Writer_Json

  • Zend_Config_Writer_Xml

  • Zend_Config_Writer_Yaml

Zend_Config オブジェクトを変更したり作成したりする際には、 知っておくべきことがあります。値を作成したり変更したりするには、 パラメータのアクセサ (->) で Zend_Config オブジェクトのパラメータを設定します。 ルート内のセクションやブランチを作成するには、新規配列を作成します ("$config->branch = array();")。 セクションの継承関係を定義するには、ルート Zend_Config オブジェクトの setExtend() メソッドをコールします。

Example #1 Zend_Config_Writer の使用法

この例では、Zend_Config_Writer_Xml で新しい設定ファイルを作成する方法を説明します。

  1. // config オブジェクトを作成します
  2. $config = new Zend_Config(array(), true);
  3. $config->production = array();
  4. $config->staging    = array();
  5.  
  6. $config->setExtend('staging', 'production');
  7.  
  8. $config->production->db = array();
  9. $config->production->db->hostname = 'localhost';
  10. $config->production->db->username = 'production';
  11.  
  12. $config->staging->db = array();
  13. $config->staging->db->username = 'staging';
  14.  
  15. // 次のいずれかの方法で設定ファイルを書き出します
  16. // a)
  17. $writer = new Zend_Config_Writer_Xml(array('config'   => $config,
  18.                                            'filename' => 'config.xml'));
  19. $writer->write();
  20.  
  21. // b)
  22. $writer = new Zend_Config_Writer_Xml();
  23. $writer->setConfig($config)
  24.        ->setFilename('config.xml')
  25.        ->write();
  26.  
  27. // c)
  28. $writer = new Zend_Config_Writer_Xml();
  29. $writer->write('config.xml', $config);

これは、production と staging というセクションを持つ XML 設定ファイルを作成します。staging は production を継承しています。

Example #2 既存の設定の変更

この例では、既存の設定ファイルを編集する方法を説明します。

  1. // すべてのセクションを既存の設定ファイルから読み込みますが継承は読み飛ばします
  2. $config = new Zend_Config_Ini('config.ini',
  3.                               null,
  4.                               array('skipExtends'        => true,
  5.                                     'allowModifications' => true));
  6.  
  7. // 値を変更します
  8. $config->production->hostname = 'foobar';
  9.  
  10. // 設定ファイルを書き出します
  11. $writer = new Zend_Config_Writer_Ini(array('config'   => $config,
  12.                                            'filename' => 'config.ini'));
  13. $writer->write();

Note: 設定ファイルの読み込み
既存の設定ファイルを読み込んで変更をする場合は、 すべてのセクションを読み込んで継承を読み飛ばすことが大切です。 そうすることで、値がマージされてしまうことがなくなります。 そのために、コンストラクタで skipExtends オプションを指定します。

構成節の文字列を作成するために、ファイル・ベースのライタ ( INIJSONXMLYAML 及び PHP 配列) 全てで内部的に render() が使用されます。 コンフィギュレーション・データの文字列表現にアクセスするために このメソッドをそれぞれ使用できます。

INI ライター特有の注意

  • INI ライターでは、セクションについてのレンダリング用のモードが2つあります。 既定では、トップレベルの構成節は、常にセクション名に含まれます。 $writer->setRenderWithoutSections() を呼ぶことにより、 オプションの全てが INI ファイルのグローバル名前空間に含まれます。 そして、セクションは使用されません。

  • Zend_Config_Writer_Ini にはオプションのパラメータ nestSeparator が用意されています。 これは、ノードを区切る文字を定義します。デフォルトはドットひとつで、 これは Zend_Config_Ini によりデフォルトで受け付けられます。

YAML ライター特有の注意

The YAML writer lets you optionally specify an alternate YAML encoder to use. By default, one is shipped with the framework that is suitable for most configuration tasks. If you find it insufficient, or wish to use more advanced YAML, you may provide an alternate encoder callback.

The method for doing so is to use the Zend_Config_Writer_Yaml::setYamlEncoder() method, passing it a valid callback.

  1. // Use the Symfony Yaml Component:
  2. $writer = new Zend_Config_Writer_Yaml($filename);
  3. $writer->setYamlEncoder(array('sfYaml', 'dump'));

The above uses the Symfony Components' sfYaml component in order to encode the configuration to YAML.

Copyright

© 2006-2018 by Zend, a Rogue Wave Company. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts