mysqli_result::fetch_field
mysqli_result::fetch_object
The MySQLi_Result class
PHP Manual

# mysqli_result::fetch_fields

# mysqli_fetch_fields

(PHP 5)

mysqli_result::fetch_fields -- mysqli_fetch_fields — 結果セットのフィールド情報をオブジェクトの配列で返す

### 説明

オブジェクト指向型（メソッド）:

array mysqli_result::fetch_fields ( void )

手続き型:

array mysqli_fetch_fields ( mysqli_result `$result` )

この関数は mysqli_fetch_field() 関数と同じ目的で 使用しますが、ひとつ違いがあります。一度にひとつずつフィールド情報を 取得するのではなく、複数のカラムの情報をオブジェクトの配列で返します。

### パラメータ

`result`

  手続き型のみ: mysqli_query()、mysqli_store_result() あるいは mysqli_use_result() が返す結果セット ID。

### 返り値

フィールド定義情報を含むオブジェクトの配列を返します。もし フィールドの情報が取得できない場合は、`FALSE` を返します。

オブジェクトのプロパティ
プロパティ | 説明
--- | ---
name | カラムの名前。
orgname | もしエイリアスが指定されている場合の、本来の名前。
table | フィールドが属するテーブルの名前。
orgtable | もしエイリアスが指定されている場合の、本来のテーブル名。
def | フィールドのデフォルト値。文字列形式。
max_length | 結果セットにおけるフィールドの最大幅。
length | テーブルの定義で指定されているフィールド幅。
charsetnr | フィールドの文字セット番号。
flags | フィールドのビットフラグを整数型で表す。
type | フィールドのデータ型。
decimals | フィールドの桁数（integer 型のフィールド）。

### 例

例1 オブジェクト指向型

`<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
/* 接続状況をチェックします */
if (mysqli_connect_errno()) {
printf("Connect failed: %s\n", mysqli_connect_error());
exit();
}
$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";
if ($result = $mysqli->query($query)) {
/* すべてのカラムのフィールド情報を取得します */
$finfo = $result->fetch_fields();
foreach ($finfo as $val) {
printf("Name: %s\n", $val->name);
printf("Table: %s\n", $val->table);
printf("max. Len: %d\n", $val->max_length);
printf("Flags: %d\n", $val->flags);
printf("Type: %d\n\n", $val->type);
}
$result->close();
}
/* 接続を閉じます */
$mysqli->close();
?>`

例2 手続き型

`<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
/* 接続状況をチェックします */
if (mysqli_connect_errno()) {
printf("Connect failed: %s\n", mysqli_connect_error());
exit();
}
$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";
if ($result = mysqli_query($link, $query)) {
/* すべてのカラムのフィールド情報を取得します */
$finfo = mysqli_fetch_fields($result);
foreach ($finfo as $val) {
printf("Name: %s\n", $val->name);
printf("Table: %s\n", $val->table);
printf("max. Len: %d\n", $val->max_length);
printf("Flags: %d\n", $val->flags);
printf("Type: %d\n\n", $val->type);
}
mysqli_free_result($result);
}
/* 接続を閉じます */
mysqli_close($link);
?>`

上の例の出力は以下となります。

    Name:     Name
    Table:    Country
    max. Len: 11
    Flags:    1
    Type:     254

    Name:     SurfaceArea
    Table:    Country
    max. Len: 10
    Flags:    32769
    Type:     4

### 参考

- mysqli_num_fields() - 結果のフィールド数を取得する
- mysqli_fetch_field_direct() - 単一のフィールドのメタデータを取得する
- mysqli_fetch_field() - 結果セットの次のフィールドを返す

mysqli_result::fetch_field
mysqli_result::fetch_object
The MySQLi_Result class
PHP Manual