PEAR Manual
PrevNext

DB_common::setFetchMode()

DB_common::setFetchMode() -- Sets the default fetch mode

Synopsis

void setFetchMode (integer $fetchmode [, string $object_class = stdClass])

Description

Sets the default fetch mode used by fetch*() and get*() methods.

Parameter

integer $fetchmode

DB_FETCHMODE_ORDERED, DB_FETCHMODE_ASSOC or DB_FETCHMODE_OBJECT.

If you will be using getCol(), the DB_FETCHMODE_ORDERED or DB_FETCHMODE_ASSOC constants can be combined with the DB_FETCHMODE_FLIPPED constant via the bitwise OR operator (|). For example: 
DB_FETCHMODE_ASSOC | DB_FETCHMODE_FLIPPED

See the Examples section, below, for more information.

string $object_class

This parameter is for use when $fetchmode is set to DB_FETCHMODE_OBJECT.

You can set this parameter to DB_row, which then causes the resulting data to populate a new instance of a DB_row object.

Return value

void - nothing is returned on success or a DB_Error object on failure

Throws

Table 26-1. Possible PEAR_Error values

Error codeError messageReasonSolution
NULL invalid fetchmode mode The given fetch mode does not exists or is not implement in your DB version. Check writing of the argument and your used version of DB.

Note

This function can not be called statically.

Example

Example 26-1. DB_FETCHMODE_ORDERED (default)

Causes ordered arrays to be returned. The order is taken from the select statement. 

<?php
// Once you have a valid DB object named $db...
$db->setFetchMode(DB_FETCHMODE_ORDERED);

$res =& $db->query('SELECT a, b FROM phptest WHERE a = 28');
$row =& $res->fetchRow();

print_r($row);
echo 'Column a is ' . $row[0];
?>

Output: 

Array
(
    [0] => 28
    [1] => hi
)
Column a is 28

Example 26-2. DB_FETCHMODE_ASSOC

Makes associative arrays, with the column names as the array keys. 

<?php
// Once you have a valid DB object named $db...
$db->setFetchMode(DB_FETCHMODE_ASSOC);

$res =& $db->query('SELECT a, b FROM phptest WHERE a = 28');
$row =& $res->fetchRow();

print_r($row);
echo 'Column a is ' . $row['a'];
?>

Output: 

Array
(
    [a] => 28
    [b] => hi
)
Column a is 28

Example 26-3. DB_FETCHMODE_OBJECT

Returns objects with column names as properties. 

<?php
// Once you have a valid DB object named $db...
$db->setFetchMode(DB_FETCHMODE_OBJECT);

$res =& $db->query('SELECT a, b FROM phptest WHERE a = 28');
$row =& $res->fetchRow();

print_r($row);
echo 'Column a is ' . $row->a;
?>

Output: 

stdClass Object
(
    [a] => 28
    [b] => hi
)
Column a is 28

Example 26-4. DB_FETCHMODE_OBJECT and DB_row

If setFetchMode()'s optional $object_class parameter is set to DB_row, DB_row objects are returned. 

<?php
// Once you have a valid DB object named $db...
$db->setFetchMode(DB_FETCHMODE_OBJECT, 'DB_row');

$res =& $db->query('SELECT a, b FROM phptest WHERE a = 28');
$row =& $res->fetchRow();

print_r($row);
echo 'Column a is ' . $row->a;
?>

Output: 

db_row Object
(
    [a] => 28
    [b] => hi
)
Column a is 28
PrevHomeNext
DB_common::rollback()UpDB_common::setOption()