com doc/ja: Remove dbx documentation: appendices/ini.list.xml install/windows/legacy/extensions.xml reference/dbx/book.xml reference/dbx/configure.xml
reference/dbx/functions/dbx-close.xml reference/dbx/functions/dbx-compare.xml reference/dbx/functions/dbx-connect.xml
reference/dbx/functions/dbx-error.xml reference/dbx/functions/dbx-escape-string.xml reference/dbx/functions/dbx-fetch-row.xml
reference/dbx/functions/dbx-query.xml reference/dbx/fun

From:	Yoshinari Takaoka	Date:	Wed, 24 Feb 2021 17:28:15 +0000
Subject:	com doc/ja: Remove dbx documentation: appendices/ini.list.xml install/windows/legacy/extensions.xml reference/dbx/book.xml reference/dbx/configure.xml reference/dbx/functions/dbx-close.xml reference/dbx/functions/dbx-compare.xml reference/dbx/functions/dbx-connect.xml reference/dbx/functions/dbx-error.xml reference/dbx/functions/dbx-escape-string.xml reference/dbx/functions/dbx-fetch-row.xml reference/dbx/functions/dbx-query.xml reference/dbx/fun
Groups:	php.doc.ja
Request:	Send a blank email to doc-ja+get-6228@lists.php.net to get a copy of this message

Commit: ae60eeabff40079e665edaebaf29aa70dc0b41aa Author: Yoshinari Takaoka <mumumu@mumumu.org> Thu, 25 Feb 2021 02:28:15 +0900 Parents: 1a293c40741147f407616dea479339900bb7d89c Branches: master Link: http://git.php.net/?p=doc/ja.git;a=commitdiff;h=ae60eeabff40079e665edaebaf29aa70dc0b41aa Log: Remove dbx documentation The extension is marked as unmaintained, and had its latest release on 2011-08-11. Changed paths: M appendices/ini.list.xml M install/windows/legacy/extensions.xml D reference/dbx/book.xml D reference/dbx/configure.xml D reference/dbx/functions/dbx-close.xml D reference/dbx/functions/dbx-compare.xml D reference/dbx/functions/dbx-connect.xml D reference/dbx/functions/dbx-error.xml D reference/dbx/functions/dbx-escape-string.xml D reference/dbx/functions/dbx-fetch-row.xml D reference/dbx/functions/dbx-query.xml D reference/dbx/functions/dbx-sort.xml D reference/dbx/ini.xml D reference/dbx/reference.xml D reference/dbx/setup.xml

diff --git a/appendices/ini.list.xml b/appendices/ini.list.xml index 6ce292f206..60adaca4c0 100644 --- a/appendices/ini.list.xml +++ b/appendices/ini.list.xml @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="utf-8"?>  - +  <section xml:id="ini.list" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -387,12 +387,6 @@ <entry></entry> </row> <row> - <entry><link linkend="ini.dbx.colnames-case">dbx.colnames_case</link></entry> - <entry>"unchanged"</entry> - <entry>PHP_INI_SYSTEM</entry> - <entry>PHP 5.1.0 で削除。</entry> - </row> - <row> <entry><link linkend="ini.default-charset">default_charset</link></entry> <entry>"UTF-8"</entry> <entry>PHP_INI_ALL</entry> diff --git a/install/windows/legacy/extensions.xml b/install/windows/legacy/extensions.xml index c82ca8009d..f27d2c02f8 100644 --- a/install/windows/legacy/extensions.xml +++ b/install/windows/legacy/extensions.xml @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?>  - +  <sect2 xml:id="install.windows.legacy.extensions" xmlns="http://docbook.org/ns/docbook"> <title>Windows 用 PHP 拡張モジュール</title> @@ -165,11 +165,6 @@ extension=php_bz2.dll <entry></entry> </row> <row> - <entry>php_dbx.dll</entry> - <entry><link linkend="book.dbx">dbx</link> 関数</entry> - <entry></entry> - </row> - <row> <entry>php_exif.dll</entry> <entry><link linkend="book.exif">EXIF</link> 関数</entry> <entry> diff --git a/reference/dbx/book.xml b/reference/dbx/book.xml deleted file mode 100644 index c16b9fc713..0000000000 --- a/reference/dbx/book.xml +++ /dev/null @@ -1,54 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - - - -<book xml:id="book.dbx" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <title>dbx</title> - -  - <preface xml:id="intro.dbx"> - &reftitle.intro; - <para> - dbx モジュールは、データベース抽象化レイヤ（db 'X' の 'X' は、 - サポートされるデータベースの一つを意味します）のことです。dbx 関数 - により、サポートされる全てのデータベースを単一の呼出表記により - アクセスすることが可能になります。dbx 関数自体は、データベースへの - 直接のインターフェイスを有しませんが、それらのデータベースをサポート - するために使用されるモジュールへのインターフェイスを有します。 - </para> - <note> - <para> - &pecl.moved-ver;5.1.0. - </para> - </note> - </preface> -  - - &reference.dbx.setup; - &reference.dbx.constants; - &reference.dbx.reference; - -</book> - - - diff --git a/reference/dbx/configure.xml b/reference/dbx/configure.xml deleted file mode 100644 index 63a50e2fb4..0000000000 --- a/reference/dbx/configure.xml +++ /dev/null @@ -1,45 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - - -<section xml:id="dbx.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - &reftitle.install; - <para> - &pecl.moved-ver;5.1.0 - </para> - <para> - &pecl.info; - <link xlink:href="&url.pecl.package;dbx">&url.pecl.package;dbx</link>. - </para> - <para> - これらの関数を利用可能にするには、 - <option role="configure">--enable-dbx</option> オプションを使用して - dbx サポートを有効にし、また、使用するデータベースに関するオプション、 - 例えば MySQL の場合は - <option role="configure">--with-mysql=[DIR]</option> - も指定して PHP をコンパイルする必要があります。 - 他のサポートされるデータベースを dbx モジュールで動作させるには、 - 個別のドキュメントを参照してください。 - </para> -</section> - - diff --git a/reference/dbx/functions/dbx-close.xml b/reference/dbx/functions/dbx-close.xml deleted file mode 100644 index b3f3e713e7..0000000000 --- a/reference/dbx/functions/dbx-close.xml +++ /dev/null @@ -1,93 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - -<refentry xml:id="function.dbx-close" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>dbx_close</refname> - <refpurpose>オープンされた接続/データベースを閉じる</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>dbx_close</methodname> - <methodparam><type>object</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>link_identifier</parameter></term> - <listitem> - <para> - 閉じたい DBX リンクオブジェクト。 - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - 成功した場合に 1、エラーの場合に 0 を返します。 - </para> - </refsect1> - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title><function>dbx_close</function> の例</title> - <programlisting role="php"> -<![CDATA[ -<?php -$link = dbx_connect(DBX_MYSQL, "localhost", "db", "username", "password") - or die("接続できませんでした"); - -echo "接続に成功しました"; -dbx_close($link); -?> -]]> - </programlisting> - </example> - </para> - </refsect1> - <refsect1 role="notes"> - &reftitle.notes; - <note> - <para> - モジュール固有のドキュメントも参照ください。 - </para> - </note> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dbx_connect</function></member> - </simplelist> - </para> - </refsect1> -</refentry> - - diff --git a/reference/dbx/functions/dbx-compare.xml b/reference/dbx/functions/dbx-compare.xml deleted file mode 100644 index 29edd735b8..0000000000 --- a/reference/dbx/functions/dbx-compare.xml +++ /dev/null @@ -1,167 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - -<refentry xml:id="function.dbx-compare" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>dbx_compare</refname> - <refpurpose>ソートするために二つのレコードを比較する</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>dbx_compare</methodname> - <methodparam><type>array</type><parameter>row_a</parameter></methodparam> - <methodparam><type>array</type><parameter>row_b</parameter></methodparam> - <methodparam><type>string</type><parameter>column_key</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>DBX_CMP_ASC | DBX_CMP_NATIVE</initializer></methodparam> - </methodsynopsis> - <para> - <function>dbx_compare</function> は - <function>dbx_sort</function> のヘルパ関数で、 - 独自のソート関数を作成しやすくします。 - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>row_a</parameter></term> - <listitem> - <para> - 最初の行。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>row_b</parameter></term> - <listitem> - <para> - 二番目の行。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>column_key</parameter></term> - <listitem> - <para> - 比較するカラム。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>flags</parameter></term> - <listitem> - <para> - <parameter>flags</parameter> によって比較の方向を指定します。 - <itemizedlist> - <listitem> - <simpara> - <constant>DBX_CMP_ASC</constant> - 昇順 - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_CMP_DESC</constant> - 降順 - </simpara> - </listitem> - </itemizedlist> - また、比較の型についても指定します。 - <itemizedlist> - <listitem> - <simpara> - <constant>DBX_CMP_NATIVE</constant> - 型の変換を行いません - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_CMP_TEXT</constant> - 文字列として比較します - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_CMP_NUMBER</constant> - 数値として比較します - </simpara> - </listitem> - </itemizedlist> - 方向からひとつ、型の定数からひとつを選び、ビット OR 演算子 (|) で - 組み合わせます。 - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - <literal>row_a[$column_key]</literal> が - <literal>row_b[$column_key]</literal> に等しい場合に <literal>0</literal>、 - 前者が後者より大きいかあるいは小さい場合にそれぞれ - <literal>1</literal> あるいは <literal>-1</literal>、 - もし <constant>DBX_CMP_DESC</constant> が設定されていればその逆を返します。 - </para> - </refsect1> - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title><function>dbx_compare</function> の例</title> - <programlisting role="php"> -<![CDATA[ -<?php -function user_re_order($a, $b) -{ - $rv = dbx_compare($a, $b, "parentid", DBX_CMP_DESC); - if (!$rv) { - $rv = dbx_compare($a, $b, "id", DBX_CMP_NUMBER); - } - return $rv; -} - -$link = dbx_connect(DBX_ODBC, "", "db", "username", "password") - or die("接続できませんでした"); - -$result = dbx_query($link, "SELECT id, parentid, description FROM table ORDER BY id"); - // $result のデータは id で並べ替えられます - -dbx_sort($result, "user_re_order"); - // $result のデータは、まず parentid の降順で並べ替えられ、次に id で並べ替えられます - -dbx_close($link); -?> -]]> - </programlisting> - </example> - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dbx_sort</function></member> - </simplelist> - </para> - </refsect1> -</refentry> - - diff --git a/reference/dbx/functions/dbx-connect.xml b/reference/dbx/functions/dbx-connect.xml deleted file mode 100644 index 2f02a2ef7e..0000000000 --- a/reference/dbx/functions/dbx-connect.xml +++ /dev/null @@ -1,243 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - -<refentry xml:id="function.dbx-connect" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>dbx_connect</refname> - <refpurpose>接続/データベースをオープンする</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>object</type><methodname>dbx_connect</methodname> - <methodparam><type>mixed</type><parameter>module</parameter></methodparam> - <methodparam><type>string</type><parameter>host</parameter></methodparam> - <methodparam><type>string</type><parameter>database</parameter></methodparam> - <methodparam><type>string</type><parameter>username</parameter></methodparam> - <methodparam><type>string</type><parameter>password</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>persistent</parameter></methodparam> - </methodsynopsis> - <para> - データベースへの接続をオープンします。 - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>module</parameter></term> - <listitem> - <para> - <parameter>module</parameter> パラメータには文字列または定数を設定します。 - 定数の使用が推奨されます。指定可能な値を以下に示しますが、これは - 該当するモジュールが実際にロードされている場合のみ動作することに注意してください。 - </para> - <para> - <itemizedlist> - <listitem> - <simpara> - <constant>DBX_MYSQL</constant> あるいは <literal>"mysql"</literal> - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_ODBC</constant> あるいは <literal>"odbc"</literal> - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_PGSQL</constant> あるいは <literal>"pgsql"</literal> - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_MSSQL</constant> あるいは <literal>"mssql"</literal> - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_FBSQL</constant> あるいは <literal>"fbsql"</literal> - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_SYBASECT</constant> あるいは <literal>"sybase_ct"</literal> - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_OCI8</constant> あるいは <literal>"oci8"</literal> - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_SQLITE</constant> あるいは <literal>"sqlite"</literal> - </simpara> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>host</parameter></term> - <listitem> - <para> - SQL サーバーのホスト。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>database</parameter></term> - <listitem> - <para> - データベース名。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>username</parameter></term> - <listitem> - <para> - ユーザー名。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>password</parameter></term> - <listitem> - <para> - パスワード。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>persistent</parameter></term> - <listitem> - <para> - <parameter>persistent</parameter> パラメータに - <constant>DBX_PERSISTENT</constant> を設定すると、持続的接続が作成されます。 - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - <parameter>host</parameter>、<parameter>database</parameter>、 - <parameter>username</parameter> および <parameter>password</parameter> - のパラメータを受け付けますが、抽象化されたモジュールの接続関数によっては - これらがすべて使われるわけではないこともあります。 - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - <function>dbx_connect</function> は成功時にオブジェクト、エラー時に &false; - を返します。接続は確立したもののデータベースが選択できなかった場合には、 - 接続はクローズされて &false; を返します。 - </para> - <para> - 返される <varname>object</varname> は 3 つのプロパティを有します。 - <variablelist> - <varlistentry> - <term> - <property>database</property> - </term> - <listitem> - <simpara> - 現在選択されているデータベースの名前。 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <property>handle</property> - </term> - <listitem> - <para> - 接続されたデータベースの有効なハンドルで、モジュール固有の関数に - （必要に応じて）使用されます。 - <informalexample> - <programlisting role="php"> -<![CDATA[ -<?php -$link = dbx_connect(DBX_MYSQL, "localhost", "db", "username", "password"); -mysql_close($link->handle); // dbx_close($link) の方が良いかもしれません -?> -]]> - </programlisting> - </informalexample> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <property>module</property> - </term> - <listitem> - <simpara> - dbx の内部でのみ使用され、上で述べたモジュール番号を表します。 - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title><function>dbx_connect</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -$link = dbx_connect(DBX_ODBC, "", "db", "username", "password", DBX_PERSISTENT) - or die("接続できませんでした"); - -echo "接続に成功しました"; -dbx_close($link); -?> -]]> - </programlisting> - </example> - </para> - </refsect1> - <refsect1 role="notes"> - &reftitle.notes; - <note> - <para> - モジュール固有のドキュメントも参照ください。 - </para> - </note> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dbx_close</function></member> - </simplelist> - </para> - </refsect1> -</refentry> - - diff --git a/reference/dbx/functions/dbx-error.xml b/reference/dbx/functions/dbx-error.xml deleted file mode 100644 index 16f8c1ea6c..0000000000 --- a/reference/dbx/functions/dbx-error.xml +++ /dev/null @@ -1,105 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - -<refentry xml:id="function.dbx-error" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>dbx_error</refname> - <refpurpose> - 使用するモジュールの最新の関数コールにおけるエラーメッセージを出力する - </refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>dbx_error</methodname> - <methodparam><type>object</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>dbx_error</function> は、直近のエラーメッセージを返します。 - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>link_identifier</parameter></term> - <listitem> - <para> - <function>dbx_connect</function> が返す DBX リンクオブジェクト。 - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - 抽象化されたモジュール（例えば mysql - モジュール）の直近の関数コールからエラーメッセージを有する文字列を返します。 - 同じモジュールに複数の接続がある場合、 - 最後のエラーのみが取得されます。別のモジュールに接続がある場合、 - （<parameter>link_identifier</parameter> パラメータで）指定した - モジュールに関する直近のエラーのみが返されます。 - </para> - </refsect1> - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title><function>dbx_error</function> の例</title> - <programlisting role="php"> -<![CDATA[ -<?php -$link = dbx_connect(DBX_MYSQL, "localhost", "db", "username", "password") - or die("接続に失敗しました"); - -$result = dbx_query($link, "select id from non_existing_table"); -if ($result == 0) { - echo dbx_error($link); -} -dbx_close($link); -?> -]]> - </programlisting> - </example> - </para> - </refsect1> - <refsect1 role="notes"> - &reftitle.notes; - <note> - <para> - モジュール固有のドキュメントも参照ください。 - </para> - <para> - <productname>Microsoft SQL Server</productname> に関するエラーメッセージは、実際には - <function>mssql_get_last_message</function> 関数の結果となります。 - </para> - <para> - Oracle (oci8) に関するエラーメッセージは、（まだ）実装されていません。 - </para> - </note> - </refsect1> -</refentry> - - diff --git a/reference/dbx/functions/dbx-escape-string.xml b/reference/dbx/functions/dbx-escape-string.xml deleted file mode 100644 index d27f551551..0000000000 --- a/reference/dbx/functions/dbx-escape-string.xml +++ /dev/null @@ -1,105 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - -<refentry xml:id="function.dbx-escape-string" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>dbx_escape_string</refname> - <refpurpose> - SQL ステートメントで安全に使用できるように文字列をエスケープする - </refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>dbx_escape_string</methodname> - <methodparam><type>object</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - </methodsynopsis> - <para> - 指定した文字列をエスケープし、SQL ステートメントで安全に使用できるようにします。 - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>link_identifier</parameter></term> - <listitem> - <para> - <function>dbx_connect</function> が返す DBX リンクオブジェクト。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>text</parameter></term> - <listitem> - <para> - エスケープする文字列。 - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - テキストを返します。 - 必要なら（クォートやバックスラッシュなど）エスケープ処理を行います。 - エラー時には &null; を返します。 - </para> - </refsect1> - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title><function>dbx_escape_string</function> の例</title> - <programlisting role="php"> -<![CDATA[ -<?php -$link = dbx_connect(DBX_MYSQL, "localhost", "db", "username", "password") - or die("接続できませんでした"); - -$text = dbx_escape_string($link, "It\'s quoted and backslashed (\\)."); -$result = dbx_query($link, "insert into tbl (txt) values ('" . $text . "')"); -if ($result == 0) { - echo dbx_error($link); -} -dbx_close($link); -?> -]]> - </programlisting> - </example> - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dbx_query</function></member> - </simplelist> - </para> - </refsect1> -</refentry> - - diff --git a/reference/dbx/functions/dbx-fetch-row.xml b/reference/dbx/functions/dbx-fetch-row.xml deleted file mode 100644 index 33ca216e0b..0000000000 --- a/reference/dbx/functions/dbx-fetch-row.xml +++ /dev/null @@ -1,114 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - -<refentry xml:id="function.dbx-fetch-row" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>dbx_fetch_row</refname> - <refpurpose><constant>DBX_RESULT_UNBUFFERED</constant> フラグを指定した - クエリ結果から、行を取得する</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>mixed</type><methodname>dbx_fetch_row</methodname> - <methodparam><type>object</type><parameter>result_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>dbx_fetch_row</function> は、 - <constant>DBX_RESULT_UNBUFFERED</constant> - フラグを指定したクエリ結果から、行を取得します。 - </para> - <para> - クエリで <constant>DBX_RESULT_UNBUFFERED</constant> が指定されていない場合、 - <function>dbx_fetch_row</function> は失敗します。なぜなら、すでにすべての - 行は取得されて <property>data</property> プロパティに格納されているからです。 - </para> - <para> - 副作用として、<function>dbx_fetch_row</function> のコールのたびに - クエリ結果オブジェクトの <property>rows</property> プロパティの - 値が加算されます。 - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>result_identifier</parameter></term> - <listitem> - <para> - <function>dbx_query</function> が返す結果セット。 - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - 成功した場合にオブジェクトを返します。このオブジェクトには、 - <function>dbx_query</function> の結果における <property>data</property> - プロパティの内容と同じ情報が含まれ、<function>dbx_query</function> - で設定した内容に応じてインデックスあるいはフィールド名でアクセスが可能です。 - </para> - <para> - 失敗した場合 (例: 行がもうない場合) - には <literal>0</literal> を返します。 - </para> - </refsect1> - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>返り値を処理する方法</title> - <programlisting role="php"> -<![CDATA[ -<?php -$result = dbx_query($link, 'SELECT id, parentid, description FROM table', DBX_RESULT_UNBUFFERED); - -echo "<table>\n"; -while ($row = dbx_fetch_row($result)) { - echo "<tr>\n"; - foreach ($row as $field) { - echo "<td>$field</td>"; - } - echo "</tr>\n"; -} -echo "</table>\n"; -?> -]]> - </programlisting> - </example> - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dbx_query</function></member> - </simplelist> - </para> - </refsect1> -</refentry> - - diff --git a/reference/dbx/functions/dbx-query.xml b/reference/dbx/functions/dbx-query.xml deleted file mode 100644 index 3ad7839d94..0000000000 --- a/reference/dbx/functions/dbx-query.xml +++ /dev/null @@ -1,397 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - -<refentry xml:id="function.dbx-query" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>dbx_query</refname> - <refpurpose>クエリを送信し、(ある場合には)結果を全て取得する</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>mixed</type><methodname>dbx_query</methodname> - <methodparam><type>object</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>sql_statement</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> - </methodsynopsis> - <para> - クエリを送信し、すべての結果を取得します。 - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>link_identifier</parameter></term> - <listitem> - <para> - <function>dbx_connect</function> が返す DBX リンクオブジェクト。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>sql_statement</parameter></term> - <listitem> - <para> - SQL 文。 - </para> - <para> - クエリ内のデータは <link - linkend="function.dbx-escape-string">適切にエスケープ</link> - しておかなければなりません。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>flags</parameter></term> - <listitem> - <para> - <parameter>flags</parameter> パラメータは、返される情報の量を制御する - ために使用されます。以下の定数の組み合わせを、論理 OR 演算子 - (|) で連結したものとなります。DBX_COLNAMES_* フラグは &php.ini; - の dbx.colnames_case 設定を上書きします。 - <variablelist> - <varlistentry> - <term> - <constant>DBX_RESULT_INDEX</constant> - </term> - <listitem> - <simpara> - これは<emphasis>常に</emphasis>設定され、結果に二次元配列の - <property>data</property> プロパティを含めます。たとえば - <literal>data[2][3]</literal> では <literal>2</literal> が行番号 - （レコード番号）を表し、<literal>3</literal> がカラム番号 - （フィールド番号）を表します。最初の行やカラムの番号は 0 です。 - </simpara> - <simpara> - <constant>DBX_RESULT_ASSOC</constant> が指定された場合、返される - オブジェクトには <constant>DBX_RESULT_INFO</constant> に関連する - 情報が（指定していなくても）含まれます。 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>DBX_RESULT_INFO</constant> - </term> - <listitem> - <simpara> - カラムに関する情報、つまりフィールド名とフィールドの型を含めます。 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>DBX_RESULT_ASSOC</constant> - </term> - <listitem> - <simpara> - 返されるオブジェクトの <property>data</property> プロパティの - キーとして、関連するカラム名の値がアクセスされます。 - </simpara> - <simpara> - 関連付けられた結果は数値添字となっているので、 - <literal>data[0][0]</literal> を変更すると - <literal>data[0]['最初のカラムのフィールド名']</literal> も同様に - 変更されます。 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>DBX_RESULT_UNBUFFERED</constant> - </term> - <listitem> - <simpara> - このフラグは <property>data</property> プロパティを作成せず、 - <property>rows</property> プロパティの初期値を 0 に設定します。 - 結果セットが大きくなる場合にこのフラグを使用し、 - <function>dbx_fetch_row</function> を使用して結果を 1 行ごとに - 取得してください。 - </simpara> - <simpara> - <function>dbx_fetch_row</function> 関数は、このクエリで設定した - フラグの内容を反映じた行を返します。また、この関数がコールされる - たびに <property>rows</property> が更新されます。 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>DBX_COLNAMES_UNCHANGED</constant> - </term> - <listitem> - <simpara> - 返されるカラム名の大文字小文字を変更しません。 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>DBX_COLNAMES_UPPERCASE</constant> - </term> - <listitem> - <simpara> - 返されるカラム名を大文字に変更します。 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>DBX_COLNAMES_LOWERCASE</constant> - </term> - <listitem> - <simpara> - 返されるカラム名を小文字に変更します。 - </simpara> - </listitem> - </varlistentry> - </variablelist> - <parameter>flags</parameter> パラメータの実際の値にかかわらず、常に - <constant>DBX_RESULT_INDEX</constant> が有効となることに注意しましょう。 - つまり、結果的に使用可能なのは以下の組み合わせだけであるということです。 - <itemizedlist> - <listitem> - <simpara> - <constant>DBX_RESULT_INDEX</constant> - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_RESULT_INDEX</constant> | - <constant>DBX_RESULT_INFO</constant> - </simpara> - </listitem> - <listitem> - <simpara> - <constant>DBX_RESULT_INDEX</constant> | - <constant>DBX_RESULT_INFO</constant> | - <constant>DBX_RESULT_ASSOC</constant> - - <parameter>flags</parameter> を指定しなかった場合、これがデフォルトです。 - </simpara> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - <function>dbx_query</function> は、成功した場合にオブジェクトあるいは - <literal>1</literal>、失敗した場合に <literal>0</literal> を返します。 - 結果オブジェクトが返されるのは、<parameter>sql_statement</parameter> - で指定されたクエリが結果セットを生成する場合（例: SELECT クエリ。結果が - 0 件の場合も含む）のみです。 - </para> - <para> - 返されるオブジェクトは、<parameter>flags</parameter> - の設定により 4 つまたは 5 つのプロパティを保持します。 - <variablelist> - <varlistentry> - <term> - <property>handle</property> - </term> - <listitem> - <para> - 接続したデータベースの有効なハンドルで、モジュール専用関数で - （必要ならば）使用されます。 - <informalexample> - <programlisting role="php"> -<![CDATA[ -<?php -$result = dbx_query($link, "SELECT id FROM table"); -mysql_field_len($result->handle, 0); -?> -]]> - </programlisting> - </informalexample> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <property>cols</property> および <property>rows</property> - </term> - <listitem> - <para> - これらは、それぞれカラム数（フィールド数）および行数（レコード数） - を表します。 - <informalexample> - <programlisting role="php"> -<![CDATA[ -<?php -$result = dbx_query($link, 'SELECT id FROM table'); -echo $result->rows; // レコード数 -echo $result->cols; // フィールド数 -?> -]]> - </programlisting> - </informalexample> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <property>info</property> (オプション) - </term> - <listitem> - <simpara> - <parameter>flags</parameter> パラメータに - <constant>DBX_RESULT_INFO</constant> あるいは - <constant>DBX_RESULT_ASSOC</constant> が指定されている場合のみ - 返されます。2 次元の配列で、2 つのキー（<literal>name</literal> - および <literal>type</literal>）を持ち、カラムの情報を取得するために - 使用します。 - </simpara> - <example> - <title>各フィールドの名前と型を一覧表示する</title> - <programlisting role="php"> -<![CDATA[ -<?php -$result = dbx_query($link, 'SELECT id FROM table', - DBX_RESULT_INDEX | DBX_RESULT_INFO); - -for ($i = 0; $i < $result->cols; $i++ ) { - echo $result->info['name'][$i] . "\n"; - echo $result->info['type'][$i] . "\n"; -} -?> -]]> - </programlisting> - </example> - </listitem> - </varlistentry> - <varlistentry> - <term> - <property>data</property> - </term> - <listitem> - <simpara> - このプロパティには結果のデータが含まれます。<parameter>flags</parameter> - の設定によってはこのデータはカラム名と関連付けられているでしょう。 - <constant>DBX_RESULT_ASSOC</constant> が設定されていた場合、 - <literal>$result->data[2]["field_name"]</literal> のように使用可能です。 - </simpara> - <example> - <title>data プロパティの内容を HTML テーブルで表示する</title> - <programlisting role="php"> -<![CDATA[ -<?php -$result = dbx_query($link, 'SELECT id, parentid, description FROM table'); - -echo "<table>\n"; -foreach ($result->data as $row) { - echo "<tr>\n"; - foreach ($row as $field) { - echo "<td>$field</td>"; - } - echo "</tr>\n"; -} -echo "</table>\n"; -?> -]]> - </programlisting> - </example> - <example> - <title>UNBUFFERED クエリの処理法</title> - <programlisting role="php"> -<![CDATA[ -<?php - -$result = dbx_query ($link, 'SELECT id, parentid, description FROM table', DBX_RESULT_UNBUFFERED); - -echo "<table>\n"; -while ($row = dbx_fetch_row($result)) { - echo "<tr>\n"; - foreach ($row as $field) { - echo "<td>$field</td>"; - } - echo "</tr>\n"; -} -echo "</table>\n"; - -?> -]]> - </programlisting> - </example> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>返り値を処理する方法</title> - <programlisting role="php"> -<![CDATA[ -<?php -$link = dbx_connect(DBX_ODBC, "", "db", "username", "password") - or die("接続できませんでした"); - -$result = dbx_query($link, 'SELECT id, parentid, description FROM table'); - -if (is_object($result) ) { - // ... ここで何かを行います。詳細は以下の例で示します。 ... - // まず、フィールド名とデータ型を表示します。 - // 次に、返されたフィールド値をもとに表を作成します。 -} else { - exit("クエリに失敗しました"); -} - -dbx_close($link); -?> -]]> - </programlisting> - </example> - </para> - </refsect1> - <refsect1 role="notes"> - &reftitle.notes; - <note> - <para> - モジュール固有のドキュメントも参照ください。 - </para> - <para> - Oracle データベースでは、クエリ結果のカラム名は小文字で返されます。 - </para> - </note> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dbx_escape_string</function></member> - <member><function>dbx_fetch_row</function></member> - <member><function>dbx_connect</function></member> - </simplelist> - </para> - </refsect1> -</refentry> - - diff --git a/reference/dbx/functions/dbx-sort.xml b/reference/dbx/functions/dbx-sort.xml deleted file mode 100644 index a0ff805b8d..0000000000 --- a/reference/dbx/functions/dbx-sort.xml +++ /dev/null @@ -1,126 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - -<refentry xml:id="function.dbx-sort" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>dbx_sort</refname> - <refpurpose> - カスタマイズされたソート関数により、dbx_query から結果をソートする - </refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>dbx_sort</methodname> - <methodparam><type>object</type><parameter>result</parameter></methodparam> - <methodparam><type>string</type><parameter>user_compare_function</parameter></methodparam> - </methodsynopsis> - <para> - <function>dbx_query</function> のコール結果を、 - 独自のソート関数で並べ替えます。 - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>result</parameter></term> - <listitem> - <para> - <function>dbx_query</function> が返す結果セット。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_compare_function</parameter></term> - <listitem> - <para> - ユーザー定義の比較関数。二つの引数を受け取り、 - 第一引数が第二引数より小さい場合に負の数、等しい場合にゼロ、 - 大きい場合に正の数を返すものでなければなりません。 - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - &return.success; - </para> - </refsect1> - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title><function>dbx_sort</function> の例</title> - <programlisting role="php"> -<![CDATA[ -<?php -function user_re_order($a, $b) -{ - $rv = dbx_compare($a, $b, "parentid", DBX_CMP_DESC); - if (!$rv) { - $rv = dbx_compare($a, $b, "id", DBX_CMP_NUMBER); - } - return $rv; -} - -$link = dbx_connect(DBX_ODBC, "", "db", "username", "password") - or die("接続できませんでした"); - -$result = dbx_query($link, "SELECT id, parentid, description FROM tbl ORDER BY id"); - // $result のデータは id で並べ替えられます - -dbx_sort($result, "user_re_order"); - // $result のデータは、まず parentid の降順で並べ替えられ、次に id で並べ替えられます - -dbx_close($link); -?> -]]> - </programlisting> - </example> - </para> - </refsect1> - <refsect1 role="notes"> - &reftitle.notes; - <note> - <para> - 可能ならば、<function>dbx_sort</function> を使用するよりも - <literal>SQL</literal> の <literal>ORDER BY</literal> - 句を使用することを推奨します。 - </para> - </note> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dbx_compare</function></member> - </simplelist> - </para> - </refsect1> -</refentry> - - diff --git a/reference/dbx/ini.xml b/reference/dbx/ini.xml deleted file mode 100644 index 5d7c9a1ce1..0000000000 --- a/reference/dbx/ini.xml +++ /dev/null @@ -1,75 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - -<section xml:id="dbx.configuration" xmlns="http://docbook.org/ns/docbook"> - &reftitle.runtime; - &extension.runtime; - <para> - <table> - <title>DBX 設定オプション</title> - <tgroup cols="4"> - <thead> - <row> - <entry>&Name;</entry> - <entry>&Default;</entry> - <entry>&Changeable;</entry> - <entry>&Changelog;</entry> - </row> - </thead> - <tbody> - <row> - <entry><link linkend="ini.dbx.colnames-case">dbx.colnames_case</link></entry> - <entry>"unchanged"</entry> - <entry>PHP_INI_SYSTEM</entry> - <entry>PHP 5.1.0 で削除されました。</entry> - </row> - </tbody> - </tgroup> - </table> - &ini.php.constants; -</para> - -&ini.descriptions.title; - -<para> - <variablelist> - <varlistentry xml:id="ini.dbx.colnames-case"> - <term> - <parameter>dbx.colnames_case</parameter> - <type>string</type> - </term> - <listitem> - <para> - カラム名は、変更されず("unchanged"の場合)に返すか、大文字 - ("uppercase"の場合)または小文字("lowercase"の場合)に変換すること - ができます。このディレクティブは、<function>dbx_query</function> - のフラグで上書きすることが可能です。 - </para> - </listitem> - </varlistentry> - - </variablelist> - </para> -</section> - - - diff --git a/reference/dbx/reference.xml b/reference/dbx/reference.xml deleted file mode 100644 index 3b95d652eb..0000000000 --- a/reference/dbx/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - - -<reference xml:id="ref.dbx" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <title>dbx &Functions;</title> - - &reference.dbx.entities.functions; - -</reference> - - diff --git a/reference/dbx/setup.xml b/reference/dbx/setup.xml deleted file mode 100644 index 3aae54b0e0..0000000000 --- a/reference/dbx/setup.xml +++ /dev/null @@ -1,99 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - - - - -<chapter xml:id="dbx.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - &reftitle.setup; - -  - <section xml:id="dbx.requirements"> - &reftitle.required; - <para> - dbx モジュールでデータベースを使用可能とするには、そのモジュールが - PHP にリンクされるかロードされる必要があり、そのデータベースを - dbx モジュールがサポートされている必要があります。現在 - 以下のデータベースがサポートされていますが、他のデータベースも - 追加される予定です。 - <itemizedlist> - <listitem> - <simpara> - <link linkend="ref.fbsql">FrontBase</link> - </simpara> - </listitem> - <listitem> - <simpara> - <link linkend="ref.mysql">MySQL</link> - </simpara> - </listitem> - <listitem> - <simpara> - <link linkend="ref.uodbc">ODBC</link> - </simpara> - </listitem> - <listitem> - <simpara> - <link linkend="ref.pgsql">PostgreSQL</link> - </simpara> - </listitem> - <listitem> - <simpara> - <link linkend="ref.oci8">Oracle (oci8)</link> - </simpara> - </listitem> - <listitem> - <simpara> - SQLite - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - dbx にデータベースのサポートを追加するためのドキュメントは、 - <link xlink:href="&url.dbx.docs;">&url.dbx.docs;</link> にあります。 - </para> - </section> -  - -  - &reference.dbx.configure; -  - -  - &reference.dbx.ini; -  - -  - <section xml:id="dbx.resources"> - &reftitle.resources; - <para> - dbx モジュールでは2種類のリソース型があります。最初のリソースは、 - データベース接続用のリンク <type>object</type> で、2 番目はクエリ結果を - 結果 <type>object</type> です。 - </para> - </section> -  - -</chapter> - - -