documentation/manual/ja/module_specs/Zend_Config-Introduction.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <!-- EN-Revision: 20765 -->
   4 <sect1 id="zend.config.introduction">
   5     <title>導入</title>
   6
   7     <para>
   8         <classname>Zend_Config</classname> は、アプリケーションの設定データを
   9         簡単に使用できるようにするために設計されたものです。
  10         階層構造になったプロパティを使用して、設定データを簡単に
  11         アプリケーションに読み込めるようになっています。
  12         設定データは、階層構造のデータ保存をサポートしている
  13         さまざまな媒体から読み込むことができます。
  14         現時点で <classname>Zend_Config</classname> が提供している設定データアダプタは
  15         <link linkend="zend.config.adapters.ini"><classname>Zend_Config_Ini</classname></link>
  16         と <link linkend="zend.config.adapters.xml"><classname>Zend_Config_Xml</classname></link>
  17         の二種類で、テキストファイルに格納された設定データを使用できるようになっています。.
  18     </para>
  19
  20     <example id="zend.config.introduction.example.using">
  21         <title>Zend_Config の使用例</title>
  22
  23         <para>
  24             通常は、<link linkend="zend.config.adapters.ini"><classname>Zend_Config_Ini</classname></link>
  25             あるいは <link linkend="zend.config.adapters.xml"><classname>Zend_Config_Xml</classname></link>
  26             のようなアダプタクラスを使用することが想定されています。
  27             しかし、もし設定データが <acronym>PHP</acronym> の配列として存在するのなら、
  28             単にそれを <classname>Zend_Config</classname> のコンストラクタに渡すだけで、
  29             シンプルなオブジェクト指向のインターフェイスを使用できます。
  30         </para>
  31
  32         <programlisting language="php"><![CDATA[
  33 // 設定データは配列で渡されます
  34 $configArray = array(
  35     'webhost'  => 'www.example.com',
  36     'database' => array(
  37         'adapter' => 'pdo_mysql',
  38         'params'  => array(
  39             'host'     => 'db.example.com',
  40             'username' => 'dbuser',
  41             'password' => 'secret',
  42             'dbname'   => 'mydatabase'
  43         )
  44     )
  45 );
  46
  47 // 設定データに対するオブジェクト指向のラッパーを作成します
  48 $config = new Zend_Config($configArray);
  49
  50 // 設定データを表示します (結果は 'www.example.com' となります)
  51 echo $config->webhost;
  52
  53 // 設定データを使用してデータベースに接続します
  54 $db = Zend_Db::factory($config->database->adapter,
  55                        $config->database->params->toArray());
  56
  57 // もうひとつの方法: 単に Zend_Config オブジェクトを渡します
  58 // Zend_Db のファクトリは、その処理方法を知っています
  59 $db = Zend_Db::factory($config->database);
  60 ]]></programlisting>
  61     </example>
  62
  63     <para>
  64         上の例で説明したように、<classname>Zend_Config</classname> を使用すると、
  65         コンストラクタに渡されたデータについて、
  66         階層化されたプロパティの形式でアクセスできるようになります。
  67     </para>
  68
  69     <para>
  70         このようにオブジェクト思考形式でデータの値にアクセスするだけでなく、
  71         <classname>Zend_Config</classname> では <code>get()</code> メソッドも用意しています。
  72         これは、指定した要素が存在しない場合にデフォルト値を返すように設定できます。
  73         たとえば次のように使用します。
  74     </para>
  75
  76     <programlisting language="php"><![CDATA[
  77 $host = $config->database->get('host', 'localhost');
  78 ]]></programlisting>
  79
  80     <example id="zend.config.introduction.example.file.php">
  81         <title>Zend_Config における PHP 設定ファイルの使用法</title>
  82
  83         <para>
  84             設定ファイルそのものを <acronym>PHP</acronym> で書きたいこともあるでしょう。
  85             以下のようにすると、簡単にそれを行うことができます。
  86         </para>
  87
  88         <programlisting language="php"><![CDATA[
  89 // config.php
  90 return array(
  91     'webhost'  => 'www.example.com',
  92     'database' => array(
  93         'adapter' => 'pdo_mysql',
  94         'params'  => array(
  95             'host'     => 'db.example.com',
  96             'username' => 'dbuser',
  97             'password' => 'secret',
  98             'dbname'   => 'mydatabase'
  99         )
 100     )
 101 );
 102 ]]></programlisting>
 103
 104         <programlisting language="php"><![CDATA[
 105 // 設定を読み込みます
 106 $config = new Zend_Config(require 'config.php');
 107
 108 // 設定データを出力します (この結果は 'www.example.com' です)
 109 echo $config->webhost;
 110 ]]></programlisting>
 111
 112     </example>
 113 </sect1>
 114 <!--
 115 vim:se ts=4 sw=4 et:
 116 -->