PHP mysqli_fetch_fields function

mysqli_fetch_fields

(PHP 5)

mysqli_fetch_fields

(no version information, might be only in CVS)

result->fetch_fields() -- Returns an array of objects representing the fields in a result setDescription

Procedural Style:

array mysqli_fetch_fields ( mysqli_result result )

Object oriented style (method):

class mysqli_result {

array fetch_fields ( void )

}

This function serves an identical purpose to the
mysqli_fetch_field() function with the single
difference that, instead of returning one object at a time for each field,
the columns are returned as an array of objects.

Parameters

result

Procedural style only: A result set
identifier returned by mysqli_query(), mysqli_store_result()
or mysqli_use_result().

Return Values

Returns an array of objects which contains field definition information or
FALSE if no field information is available.

Table 1. Object properties

PropertyDescriptionnameThe name of the columnorgnameOriginal column name if an alias was specifiedtableThe name of the table this field belongs to (if not calculated)orgtableOriginal table name if an alias was specifieddefThe default value for this field, represented as a stringmax_lengthThe maximum width of the field for the result set.lengthThe width of the field, as specified in the table definition.charsetnrThe character set number for the field.flagsAn integer representing the bit-flags for the field.typeThe data type used for this fielddecimalsThe number of decimals used (for integer fields)

Examples

Example 1. Object oriented style

$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

/* check connection */
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)) {

/* Get field information for all columns */
$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();
}