<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.9 $ -->
 <reference id="ref.dbase">
  <title>dBase 関数</title>
  <titleabbrev>dBase</titleabbrev>

  <partintro>
   <simpara>
    これらの関数は、dBase 形式(dbf)のデータベースに保存されたレコード
    にアクセスすることを可能にします。
   </simpara>
   <simpara>
    これらの関数では、インデックスおよびメモフィールドのサポートは行わ
    れません。ロックのサポートも行われません。二つの Web サーバープロ
    セスが同時に同じ dBase ファイルを修正しようとした場合、データベー
    スはほぼ確実に駄目になってしまうでしょう。
   </simpara>
   <simpara>
    dBaseファイルは、固定長の単純なシーケンシャルファイルです。レコー
    ドは、ファイルの終りに追加され、削除されたレコードは
    <function>dbase_pack</function>がコールされるまで保持されます。
   </simpara>
    <simpara>
    商用データベースとして dBase ファイルを使用するべきではありません。
    本物の SQL サーバーを替わりに選んで下さい。通常、MySQL または
    Postgresが PHP で使用されています。dBase ファイルフォーマットは
    Windows の表計算ソフトや統合ソフトで通常サポートされているので、
    dBase サポートにより Web データベースとのデータのインポート/エクス
    ポートが可能となります。
   </simpara>
  </partintro>

  <refentry id="function.dbase-create">
   <refnamediv>
    <refname>dbase_create</refname>
    <refpurpose>dBase データベースを作成する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>dbase_create</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
      <methodparam><type>array</type><parameter>fields</parameter></methodparam>
     </methodsynopsis>
    <para>
     <parameter>fields</parameter> パラメータは、配列の配列です。各配
     列は、データベースにおける一つのフィールドのフォーマットを記述し
     ます。各フィールドは、名前、フィールド型、長さ、精度を示す文字か
     ら構成されます。
    </para>
    <para>
     利用可能なフィールド型は次のようになります。
     <variablelist>
      <varlistentry>
       <term>L</term>
       <listitem>
	<simpara>
	 論理値。長さも精度もありません。
	</simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term>M</term>
       <listitem>
	<simpara>
	 メモ。(PHP ではサポートされないことに注意して下さい。)
	 長さも精度もありません。
	</simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term>D</term>
       <listitem>
	<simpara>
	 日付(Date) (YYYYMMDD という形式で保持されます)。
	 長さも精度もありません。
	</simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term>N</term>
       <listitem>
	<simpara>
	 番号(Number)。長さおよび精度(小数点以下の桁数)を有します。
	</simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term>C</term>
       <listitem>
	<simpara>
	 文字列。
	</simpara>
       </listitem>
      </varlistentry>
     </variablelist></para>
    <para>
     データベースの作成に成功した場合、dbase ID が返されます。失敗した
     場合は、&false; が返されます。
     <example>
      <title>dBaseデータベースファイルを作成する</title>
      <programlisting role="php">
<![CDATA[
// データベース名
$dbname = "/tmp/test.dbf";
 
// データベースの定義
$def =
    array(
        array("date",     "D"),
        array("name",     "C",  50),
        array("age",      "N",   3, 0),
        array("email",    "C", 128),
        array("ismember", "L")
    );
 
// 作成
if (!dbase_create($dbname, $def))
    print "<strong>Error!</strong>";
]]>
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.dbase-open">
   <refnamediv>
    <refname>dbase_open</refname>
    <refpurpose>dBase データベースをオープンする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>dbase_open</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
      <methodparam><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     フラグは、open() システムコールにおけるフラグに対応します。
     (通常、0 は読込のみ可、1 は書込のみ可、2 は読み書きを意味します)
    </para>
    <para>
     オープンされたデータベースの dbase ID を返します。
     データベースをオープンできなかった場合は、&false; を返します。
    </para>
    &note.sm.uidcheck;
   </refsect1>
  </refentry>

  <refentry id="function.dbase-close">
   <refnamediv>
    <refname>dbase_close</refname>
    <refpurpose>dBase データベースを閉じる</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>dbase_close</methodname>
      <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
     </methodsynopsis>
    <para>
     <parameter>dbase_identifier</parameter>が指すデータベースを閉じま
     す。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.dbase-pack">
   <refnamediv>
    <refname>dbase_pack</refname>
    <refpurpose>dBase データベースをパックする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>dbase_pack</methodname>
      <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
     </methodsynopsis>
    <para>
     指定されたデータベースをパックします。
     (<function>dbase_delete_record</function> を用いて削除指定を行っ
     た全てのレコードの削除を実際に行います。)
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.dbase-add-record">
   <refnamediv>
    <refname>dbase_add_record</refname>
    <refpurpose>dBase データベースにレコードを追加する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>dbase_add_record</methodname>
      <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
      <methodparam><type>array</type><parameter>record</parameter></methodparam>
     </methodsynopsis>
    <para>
     <parameter>record</parameter> のデータをデータベースに追加します。
     指定したレコード中の項目数が、データベース中のフィールド数と等し
     くない場合、処理は失敗し、&false; が返されます。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.dbase-replace-record">
   <refnamediv>
    <refname>dbase_replace_record</refname>
    <refpurpose>dBase データベースのレコードを置換する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>dbase_replace_record</methodname>
      <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
      <methodparam><type>array</type><parameter>record</parameter></methodparam>
      <methodparam><type>int</type><parameter>dbase_record_number</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     データベースのレコード<parameter>record_number</parameter>が指す
     データを<parameter>record</parameter>のデータで置換します。指定し
     たレコードの項目数がデータベースのフィールド数に等しくない場合、
     操作は失敗し、&false;が返されます。
    </simpara>
    <simpara>
     <parameter>dbase_record_number</parameter> は1からデータベースの
     レコード数までの範囲の整数となります。
     (<function>dbase_numrecords</function>により返されます)
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.dbase-delete-record">
   <refnamediv>
    <refname>dbase_delete_record</refname>
    <refpurpose>dBase データベースからレコードを削除する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>dbase_delete_record</methodname>
      <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
      <methodparam><type>int</type><parameter>record</parameter></methodparam>
     </methodsynopsis>
    <para>
     データベースから削除したいレコード <parameter>record</parameter>
     をマークします。実際に削除を行うには、
     <function>dbase_pack</function> をコールする必要があります。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.dbase-get-record">
   <refnamediv>
    <refname>dbase_get_record</refname>
    <refpurpose>dBase データベースからレコードを得る</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>array</type><methodname>dbase_get_record</methodname>
      <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
      <methodparam><type>int</type><parameter>record</parameter></methodparam>
     </methodsynopsis>
    <para>
     <parameter>record</parameter> からのデータが配列に返されます。配
     列の添字は 0から始まり、連想配列のメンバー 'deleted' を含んでいま
     す。これには、そのレコードに削除指定が行われている場合に 1 がセッ
     トされます。(<function>dbase_delete_record</function> も参照下さ
     い。)
    </para>
    <para>
     各フィールドは、適当な PHP 型に変換されます。
     <itemizedlist>
      <listitem>
       <simpara>
        日付は、文字列のままとなります。
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        整数は、オーバーフロー(>32ビット)を起こす可能性がある整数が文
        字列として返します。
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.dbase-get-record-with-names">
   <refnamediv>
    <refname>dbase_get_record_with_names</refname>
    <refpurpose>
     dBaseデータベースからレコードを連想配列として得る
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>array</type><methodname>dbase_get_record_with_names</methodname>
      <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
      <methodparam><type>int</type><parameter>record</parameter></methodparam>
     </methodsynopsis>
    <para>
     <parameter>record</parameter> からデータを連想配列として返します。
     配列は、レコードに削除のマークが付けられている場合は、連想配列に
     メンバー'deleted'が付加され、その値は1となります。
     (<function>dbase_delete_record</function>を参照下さい。)
    </para>
    <para>
     各フィールドは以下の例外を除き表示適当なPHP型に変換されます。
     <itemizedlist>
      <listitem>
       <simpara>
        日付は文字列のままとなります。
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        オーバーフローを発生するような整数(>32ビット)は、文字列として
        返されます。
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.dbase-numfields">
   <refnamediv>
    <refname>dbase_numfields</refname>
    <refpurpose>
     dBase データベースにおけるフィールド数を返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>dbase_numfields</methodname>
      <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
     </methodsynopsis>
    <para>
     指定したデータベースにおけるフィールド(カラム)数を返します。フィー
     ルド番号は 0 から dbase_numfields($db)-1 まで、レコード番号は 1
     から dbase_numrecords($db) までです。
     <example>
      <title><function>dbase_numfields</function> の使用法</title>
      <programlisting>
<![CDATA[
$rec = dbase_get_record($db, $recno);
$nf  = dbase_numfields($db);
for ($i=0; $i < $nf; $i++) {
    print $rec[$i]."<br>\n";
}
]]>
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.dbase-numrecords">
   <refnamediv>
    <refname>dbase_numrecords</refname>
    <refpurpose>
     dBase データベースにおけるレコード数を返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>dbase_numrecords</methodname>
      <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
     </methodsynopsis>
    <para>
     指定したデータベースにレコード(行)数を返します。レコード番号は 1
     から dbase_numrecords($db) まで、フィールド番号は 0 から
     dbase_numfields($db)-1 までです。
    </para>
   </refsect1>
  </refentry>

 </reference>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->