Fetch Field
Contents |
[edit] $db->fetch_field
1) fetch_field -- Fetch one specific field from a row being queried
[edit] Description
string fetch_field ( resource query, string field [, int row] )
Retrieves the contents of one cell from a MySQL result set.
When working on large result sets, you should consider using one of the functions that fetch an entire row (i.e. $db->fetch_array()). As these functions return the contents of multiple cells in one function call, they're MUCH quicker than $db->fetch_field(). Also, note that specifying a numeric offset for the field argument is much quicker than specifying a fieldname or tablename.fieldname argument.
[edit] Parameters
query
The query resource id that is being evaluated. This result comes from a call to $db->query().
field
The name or offset of the field being retrieved.
row
The row number from the result that's being retrieved. Row numbers start at 0.
It can be the field's offset, the field's name, or the field's table dot
field name (tablename.fieldname). If the column name has been aliased
('select foo as bar from...'), use the alias instead of the column name. If
undefined, the first field is retrieved.
[edit] Return Values
The contents of one cell from a MySQL result set on success, or FALSE on failure.
[edit] Examples
Example 1. $db->fetch_field() example
$query = $db->simple_select("settings", "*",
"name='boardclosed_reason'");
$title = $db->fetch_field($query, "title");
// Outputs: "Board Closed Reason"
echo $title;
[edit] Notes
Note: Calls to $db->fetch_field() should not be mixed with calls to other functions that deal with the result set.