MYSQLI_FETCH_FIELDS(3) 1 MYSQLI_FETCH_FIELDS(3)
mysqli_result::fetch_fields - Returns an array of objects representing the fields in a result set
Object oriented style
SYNOPSIS
array mysqli_result::fetch_fields (void )
DESCRIPTION
Procedural style
array mysqli_fetch_fields (mysqli_result $result)
This function serves an identical purpose to the mysqli_fetch_field(3) 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
o $
result -Procedural style only: A result set identifier returned by mysqli_query(3), mysqli_store_result(3) or
mysqli_use_result(3).
RETURN VALUES
Returns an array of objects which contains field definition information or FALSE if no field information is available.
Object properties
+-----------+---------------------------------------------------+
| Property | |
| | |
| | Description |
| | |
+-----------+---------------------------------------------------+
| name | |
| | |
| | The name of the column |
| | |
| orgname | |
| | |
| | Original column name if an alias was specified |
| | |
| table | |
| | |
| | The name of the table this field belongs to (if |
| | not calculated) |
| | |
| orgtable | |
| | |
| | Original table name if an alias was specified |
| | |
|max_length | |
| | |
| | The maximum width of the field for the result |
| | set. |
| | |
| length | |
| | |
| | The width of the field, as specified in the table |
| | definition. |
| | |
|charsetnr | |
| | |
| | The character set number for the field. |
| | |
| flags | |
| | |
| | An integer representing the bit-flags for the |
| | field. |
| | |
| type | |
| | |
| | The data type used for this field |
| | |
| decimals | |
| | |
| | The number of decimals used (for integer fields) |
| | |
+-----------+---------------------------------------------------+
EXAMPLES
Example #1
Object oriented style
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s
", 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
", $val->name);
printf("Table: %s
", $val->table);
printf("max. Len: %d
", $val->max_length);
printf("Flags: %d
", $val->flags);
printf("Type: %d
", $val->type);
}
$result->close();
}
/* close connection */
$mysqli->close();
?>
Example #2
Procedural style
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s
", mysqli_connect_error());
exit();
}
$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";
if ($result = mysqli_query($link, $query)) {
/* Get field information for all columns */
$finfo = mysqli_fetch_fields($result);
foreach ($finfo as $val) {
printf("Name: %s
", $val->name);
printf("Table: %s
", $val->table);
printf("max. Len: %d
", $val->max_length);
printf("Flags: %d
", $val->flags);
printf("Type: %d
", $val->type);
}
mysqli_free_result($result);
}
/* close connection */
mysqli_close($link);
?>
The above examples will output:
Name: Name
Table: Country
max. Len: 11
Flags: 1
Type: 254
Name: SurfaceArea
Table: Country
max. Len: 10
Flags: 32769
Type: 4
SEE ALSO
mysqli_num_fields(3), mysqli_fetch_field_direct(3), mysqli_fetch_field(3).
PHP Documentation Group MYSQLI_FETCH_FIELDS(3)