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 set
Description
Procedural Style:
mixed
mysqli_fetch_fields ( object result)
Object oriented style (method):
class
result {
mixed
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.
Return values
Returns an array of objects which contains field definition informations or FALSE if no field information
is available.
Table 1. 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 |
| def | The default value for this field, represented as a string |
| max_length | The maximum width of the field for the result set. |
| 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) |
Example
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\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();
for ($i=0; $i < count($finfo); $i++) {
printf("Name: %s\n", $finfo[$i]->name);
printf("Table: %s\n", $finfo[$i]->table);
printf("max. Len: %d\n", $finfo[$i]->max_length);
printf("Flags: %d\n", $finfo[$i]->flags);
printf("Type: %d\n\n", $finfo[$i]->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\n", 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);
for ($i=0; $i < count($finfo); $i++) {
printf("Name: %s\n", $finfo[$i]->name);
printf("Table: %s\n", $finfo[$i]->table);
printf("max. Len: %d\n", $finfo[$i]->max_length);
printf("Flags: %d\n", $finfo[$i]->flags);
printf("Type: %d\n\n", $finfo[$i]->type);
}
mysqli_free_result($result);
}
/* close connection */
mysqli_close($link);
?>
|
|
The above examples would produce the following output:
Name: Name
Table: Country
max. Len: 11
Flags: 1
Type: 254
Name: SurfaceArea
Table: Country
max. Len: 10
Flags: 32769
Type: 4 |