mysqli_result::fetch_field

mysqli_fetch_field

(PHP 5, PHP 7, PHP 8)

mysqli_result::fetch_field -- mysqli_fetch_field結果セットの次のフィールドを返す

説明

オブジェクト指向型

public mysqli_result::fetch_field(): object|false

手続き型

mysqli_fetch_field(mysqli_result $result): object|false

結果セットから ひとつのカラムの情報をオブジェクトとして返します。この関数を 繰り返しコールすることで、結果セットのすべてのカラムについての情報が 取得可能です。

パラメータ

result

手続き型のみ: mysqli_query()mysqli_store_result()mysqli_use_result()mysqli_stmt_get_result() が返す mysqli_result オブジェクト。

戻り値

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

オブジェクトのプロパティ
プロパティ 説明
name カラムの名前。
orgname もしエイリアスが指定されている場合の、本来の名前。
table フィールドが属するテーブルの名前。
orgtable もしエイリアスが指定されている場合の、本来のテーブル名。
def デフォルト値のために予約済。現在は常に ""。
db データベース名
catalog カタログ名。常に "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)) {

/* すべてのカラムのフィールド情報を取得します */
while ($finfo = $result->fetch_field()) {

printf("Name: %s\n", $finfo->name);
printf("Table: %s\n", $finfo->table);
printf("max. Len: %d\n", $finfo->max_length);
printf("Flags: %d\n", $finfo->flags);
printf("Type: %d\n\n", $finfo->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)) {

/* すべてのカラムのフィールド情報を取得します */
while ($finfo = mysqli_fetch_field($result)) {

printf("Name: %s\n", $finfo->name);
printf("Table: %s\n", $finfo->table);
printf("max. Len: %d\n", $finfo->max_length);
printf("Flags: %d\n", $finfo->flags);
printf("Type: %d\n\n", $finfo->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

参考