mysqli_fetch_field_direct

(PHP 5)

mysqli_fetch_field_direct

(no version information, might be only in CVS)

result->fetch_field_direct() -- 単一のフィールドのメタデータを取得する

説明

手続き型:

object mysqli_fetch_field_direct ( mysqli_result result, int fieldnr )

オブジェクト指向型(メソッド):

class mysqli_result {

object fetch_field_direct ( int fieldnr )

}

指定した結果セットから、フィールド定義情報を含むオブジェクトを返します。

パラメータ

result

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

fieldnr

フィールド番号。この値は 0 から フィールド数 - 1 までの範囲でなければなりません。

返り値

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

表 1. オブジェクトの属性

属性説明
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 Name LIMIT 5";

if (
$result = $mysqli->query($query)) {

    
/* カラム 'SurfaceArea' のフィールド情報を取得します */
    
$finfo = $result->fetch_field_direct(1);

    
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", $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 Name LIMIT 5";

if (
$result = mysqli_query($link, $query)) {

    
/* カラム 'SurfaceArea' のフィールド情報を取得します */
    
$finfo = mysqli_fetch_field_direct($result, 1);

    
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", $finfo->type);

    
mysqli_free_result($result);
}

/* 接続を閉じます */
mysqli_close($link);
?>

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

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

参考

mysqli_num_fields()
mysqli_fetch_field()
mysqli_fetch_fields()