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

# mysqli_result::fetch_fields

# mysqli_fetch_fields

(PHP 5, PHP 7)

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

### 説明

オブジェクト指向型

mysqli_result::fetch_fields ( void ) : array

手続き型

mysqli_fetch_fields ( mysqli_result `$result` ) : array

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

### パラメータ

`result`

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

### 返り値

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

オブジェクトのプロパティ
プロパティ | 説明
--- | ---
name | カラムの名前。
orgname | もしエイリアスが指定されている場合の、本来の名前。
table | フィールドが属するテーブルの名前。
orgtable | もしエイリアスが指定されている場合の、本来のテーブル名。
max_length | 結果セットにおけるフィールドの最大幅。
length | テーブルの定義で指定されているフィールド幅 (バイト単位)。 この値 (バイト数) は、利用している文字セットによってはテーブル定義の値 (文字数) と異なるかもしれないことに注意しましょう。 たとえば utf8 の場合は一文字あたり3バイトなので、varchar(10) の長さは30になります。 一方、同じ定義でも latin1 の場合の長さは10になります。
charsetnr | フィールドの文字セット番号 (id)。
flags | フィールドのビットフラグを整数型で表す。
type | フィールドのデータ型。
decimals | フィールドの桁数（integer 型のフィールド）。

### 例

例1 オブジェクト指向型

`<?php
$mysqli = new mysqli("127.0.0.1", "root", "foofoo", "sakila");
/* 接続状況をチェックします */
if ($mysqli->connect_errno) {
printf("Connect failed: %s\n", $mysqli->connect_error);
exit();
}
foreach (array('latin1', 'utf8') as $charset) {
// 文字セットを設定します。これは、バイト単位の長さなどいくつかの値に影響を及ぼします
$mysqli->set_charset($charset);
$query = "SELECT actor_id, last_name from actor ORDER BY actor_id";
echo "======================\n";
echo "Character Set: $charset\n";
echo "======================\n";
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("Length: %d\n", $val->length);
printf("charsetnr: %d\n", $val->charsetnr);
printf("Flags: %d\n", $val->flags);
printf("Type: %d\n\n", $val->type);
}
$result->free();
}
}
$mysqli->close();
?>`

例2 手続き型

`<?php
$link = mysqli_connect("127.0.0.1", "my_user", "my_password", "sakila");
/* 接続状況をチェックします */
if (mysqli_connect_errno()) {
printf("Connect failed: %s\n", mysqli_connect_error());
exit();
}
foreach (array('latin1', 'utf8') as $charset) {
// 文字セットを設定します。これは、バイト単位の長さなどいくつかの値に影響を及ぼします
mysqli_set_charset($link, $charset);
$query = "SELECT actor_id, last_name from actor ORDER BY actor_id";
echo "======================\n";
echo "Character Set: $charset\n";
echo "======================\n";
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("Length: %d\n", $val->length);
printf("charsetnr: %d\n", $val->charsetnr);
printf("Flags: %d\n", $val->flags);
printf("Type: %d\n\n", $val->type);
}
mysqli_free_result($result);
}
}
mysqli_close($link);
?>`

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

    ======================
    Character Set: latin1
    ======================
    Name:      actor_id
    Table:     actor
    Max. Len:  3
    Length:    5
    charsetnr: 63
    Flags:     49699
    Type:      2

    Name:      last_name
    Table:     actor
    Max. Len:  12
    Length:    45
    charsetnr: 8
    Flags:     20489
    Type:      253

    ======================
    Character Set: utf8
    ======================
    Name:      actor_id
    Table:     actor
    Max. Len:  3
    Length:    5
    charsetnr: 63
    Flags:     49699
    Type:      2

    Name:      last_name
    Table:     actor
    Max. Len:  12
    Length:    135
    charsetnr: 33
    Flags:     20489

### 参考

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