Security advisory: Critical remote code execution vulnerabilities, update now

PDOStatement::fetch

(PHP 5 >= 5.1.0, PHP 7, PHP 8, PECL pdo >= 0.1.0)

PDOStatement::fetch — Recupera la siguiente línea de un conjunto de resultados PDO

Descripción

public function PDOStatement::fetch(int $mode = PDO::FETCH_DEFAULT, int $cursorOrientation = PDO::FETCH_ORI_NEXT, int $cursorOffset = 0): mixed

Recupera una línea de un conjunto de resultados asociado a una instancia de PDOStatement. El argumento mode determina la forma en que PDO devuelve la línea.

Parámetros

mode

Controla cómo se devolverá la siguiente línea al llamante. Este valor debe ser una de las constantes PDO::FETCH_*, y por defecto vale el valor de PDO::ATTR_DEFAULT_FETCH_MODE (que por defecto es PDO::FETCH_BOTH).

  • PDO::FETCH_ASSOC: devuelve un array indexado por el nombre de la columna como se devuelve en el conjunto de resultados.

  • PDO::FETCH_NAMED: devuelve un array de la misma forma que PDO::FETCH_ASSOC, excepto que si hay varias columnas con el mismo nombre, el valor al que apunta esa clave será un array con todos los valores de la línea que tenían ese nombre de columna.

  • PDO::FETCH_NUM: devuelve un array indexado por el número de la columna como se devuelve en el conjunto de resultados, comenzando en la columna 0.

  • PDO::FETCH_BOTH: devuelve un array indexado por el nombre de la columna y también por el número de la columna, comenzando en 0, como se devuelve en el conjunto de resultados. Es, en la práctica, una combinación de PDO::FETCH_NUM y PDO::FETCH_ASSOC.

  • PDO::FETCH_BOUND: devuelve true y asigna los valores de las columnas del conjunto de resultados a las variables PHP a las que se vincularon con el método PDOStatement::bindColumn().

  • PDO::FETCH_OBJ: devuelve una instancia de stdClass con nombres de propiedades que corresponden a los nombres de las columnas devueltas en el conjunto de resultados.

  • PDO::FETCH_CLASS: devuelve una nueva instancia de la clase solicitada. A menos que la clase se haya establecido con PDOStatement::setFetchMode(), este modo debe combinarse con PDO::FETCH_CLASSTYPE, en cuyo caso la clase a instanciar se determina a partir del valor de la primera columna.

    Por defecto, el objeto se inicializa asignando las columnas del conjunto de resultados a las propiedades de la clase. Esto ocurre antes de llamar al constructor, lo que permite poblar las propiedades independientemente de su visibilidad o de si están marcadas como readonly, siempre que el constructor no las inicialice por sí mismo. Si una propiedad no existe en la clase, se invocará el método mágico __set() si existe; de lo contrario, se creará una propiedad pública dinámica.

    Es posible cambiar este comportamiento utilizando la bandera PDO::FETCH_PROPS_LATE para llamar al constructor antes de poblar las propiedades.

    Precaución

    Los valores de las columnas no se pasan como argumentos al constructor, tanto si se utiliza PDO::FETCH_PROPS_LATE como si no. Solo se pasan los argumentos proporcionados a PDOStatement::setFetchMode().

  • PDO::FETCH_INTO: actualiza una instancia existente de la clase solicitada, asignando las columnas del conjunto de resultados a las propiedades con el mismo nombre de la clase.

  • PDO::FETCH_LAZY: combina PDO::FETCH_BOTH y PDO::FETCH_OBJ, y devuelve un objeto PDORow que crea los nombres de las propiedades del objeto a medida que se accede a ellas.

cursorOrientation

Para un objeto PDOStatement que representa un cursor desplazable, este valor determina qué línea se devolverá al llamante. Este valor debe ser una de las constantes PDO::FETCH_ORI_*, y por defecto vale PDO::FETCH_ORI_NEXT. Para solicitar un cursor desplazable para el objeto PDOStatement, el atributo PDO::ATTR_CURSOR debe establecerse a PDO::CURSOR_SCROLL cuando se prepara la sentencia SQL con PDO::prepare().

cursorOffset

Si el valor del argumento cursorOrientation es PDO::FETCH_ORI_ABS, este valor especifica el número absoluto de la línea del conjunto de resultados que debe ser recuperada.

Si el valor del argumento cursorOrientation es PDO::FETCH_ORI_REL, este valor especifica la línea a recuperar relativa a la posición del cursor antes de llamar a PDOStatement::fetch().

Valores devueltos

El valor devuelto por esta función en caso de éxito depende del tipo de recuperación. En todos los casos, se devuelve false si ocurre un error o si no hay más líneas.

Errores/Excepciones

Emite un error de nivel E_WARNING si el atributo PDO::ATTR_ERRMODE está definido a PDO::ERRMODE_WARNING.

Lanza una excepción PDOException si el atributo PDO::ATTR_ERRMODE está definido a PDO::ERRMODE_EXCEPTION.

Ejemplos

Ejemplo #1 Recuperación de líneas utilizando diferentes estilos de recuperación

<?php
$db = new PDO('sqlite::memory:');
$db->exec("CREATE TABLE fruit (name VARCHAR(100), colour VARCHAR(100))");
$db->exec("INSERT INTO fruit (name, colour) VALUES
                             ('apple', 'red'),
                             ('banana', 'yellow'),
                             ('orange', 'orange'),
                             ('kiwi', 'green')");
$sth = $db->prepare("SELECT name, colour FROM fruit");
$sth->execute();

/* Probar los estilos de PDOStatement::fetch */
echo "PDO::FETCH_ASSOC: ";
echo "Devuelve la siguiente línea como un array indexado por el nombre de la columna\n";
$result = $sth->fetch(PDO::FETCH_ASSOC);
var_dump($result);
echo "\n";

echo "PDO::FETCH_BOTH: ";
echo "Devuelve la siguiente línea como un array indexado por el nombre y el número de la columna\n";
$result = $sth->fetch(PDO::FETCH_BOTH);
var_dump($result);
echo "\n";

echo "PDO::FETCH_LAZY: ";
echo "Devuelve la siguiente línea como un objeto PDORow con los nombres de las columnas como propiedades\n";
$result = $sth->fetch(PDO::FETCH_LAZY);
var_dump($result);
echo "\n";

echo "PDO::FETCH_OBJ: ";
echo "Devuelve la siguiente línea como un objeto stdClass con los nombres de las columnas como propiedades\n";
$result = $sth->fetch(PDO::FETCH_OBJ);
var_dump($result);
echo "\n";
?>

El ejemplo anterior mostrará:

PDO::FETCH_ASSOC: Devuelve la siguiente línea como un array indexado por el nombre de la columna
array(2) {
  ["name"]=>
  string(5) "apple"
  ["colour"]=>
  string(3) "red"
}

PDO::FETCH_BOTH: Devuelve la siguiente línea como un array indexado por el nombre y el número de la columna
array(4) {
  ["name"]=>
  string(6) "banana"
  [0]=>
  string(6) "banana"
  ["colour"]=>
  string(6) "yellow"
  [1]=>
  string(6) "yellow"
}

PDO::FETCH_LAZY: Devuelve la siguiente línea como un objeto PDORow con los nombres de las columnas como propiedades
object(PDORow)#3 (3) {
  ["queryString"]=>
  string(30) "SELECT name, colour FROM fruit"
  ["name"]=>
  string(6) "orange"
  ["colour"]=>
  string(6) "orange"
}

PDO::FETCH_OBJ: Devuelve la siguiente línea como un objeto stdClass con los nombres de las columnas como propiedades
object(stdClass)#4 (2) {
  ["name"]=>
  string(4) "kiwi"
  ["colour"]=>
  string(5) "green"
}

Ejemplo #2 Recuperación de líneas con un cursor desplazable

<?php
function readDataForwards($dbh) {
    $sql = 'SELECT hand, won, bet FROM mynumbers ORDER BY BET';
    $stmt = $dbh->prepare($sql, array(PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL));
    $stmt->execute();
    while ($row = $stmt->fetch(PDO::FETCH_NUM, PDO::FETCH_ORI_NEXT)) {
        $data = $row[0] . "\t" . $row[1] . "\t" . $row[2] . "\n";
        print $data;
    }
}
function readDataBackwards($dbh) {
    $sql = 'SELECT hand, won, bet FROM mynumbers ORDER BY bet';
    $stmt = $dbh->prepare($sql, array(PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL));
    $stmt->execute();
    $row = $stmt->fetch(PDO::FETCH_NUM, PDO::FETCH_ORI_LAST);
    do {
        $data = $row[0] . "\t" . $row[1] . "\t" . $row[2] . "\n";
        print $data;
    } while ($row = $stmt->fetch(PDO::FETCH_NUM, PDO::FETCH_ORI_PRIOR));
}

print "Lectura hacia adelante:\n";
readDataForwards($conn);

print "Lectura hacia atrás:\n";
readDataBackwards($conn);
?>

El ejemplo anterior mostrará:

Lectura hacia adelante:
21    10    5
16    0     5
19    20    10

Lectura hacia atrás:
19    20    10
16    0     5
21    10    5

Ejemplo #3 Orden de construcción

Cuando los objetos se recuperan mediante PDO::FETCH_CLASS, las propiedades del objeto se asignan primero y después se invoca el constructor de la clase. Sin embargo, cuando PDO::FETCH_PROPS_LATE también está especificado, este orden se invierte, es decir, primero se llama al constructor y después se asignan las propiedades.

<?php
class Person
{
    private $name;

    public function __construct()
    {
        $this->tell();
    }

    public function tell()
    {
        if (isset($this->name)) {
            echo "Soy {$this->name}.\n";
        } else {
            echo "Aún no tengo nombre.\n";
        }
    }
}

$sth = $dbh->query("SELECT * FROM people");
$sth->setFetchMode(PDO::FETCH_CLASS, 'Person');
$person = $sth->fetch();
$person->tell();
$sth->setFetchMode(PDO::FETCH_CLASS|PDO::FETCH_PROPS_LATE, 'Person');
$person = $sth->fetch();
$person->tell();
?>

Resultado del ejemplo anterior es similar a:

Soy Alice.
Soy Alice.
Aún no tengo nombre.
Soy Bob.

Véase también

+add a note

User Contributed Notes 22 notes

up
90
terry at bitsoup dot com
20 years ago
WARNING:
fetch() does NOT adhere to SQL-92 SQLSTATE standard when dealing with empty datasets.

Instead of setting the errorcode class to 20 to indicate "no data found", it returns a class of 00 indicating success, and returns NULL to the caller.

This also prevents the exception mechainsm from firing.

Programmers will need to explicitly code tests for empty resultsets after any fetch*() instead of relying on the default behavior of the RDBMS.

I tried logging this as a bug, but it was dismissed as "working as intended". Just a head's up.
up
79
yarco dot wang at gmail dot com
12 years ago
If no record, this function will also return false.
I think that is not very good...
up
36
henry at henrysmith dot org
15 years ago
Someone's already pointed out that PDO::CURSOR_SCROLL isn't supported by the SQLite driver. It's also worth noting that it's not supported by the MySQL driver either.

In fact, if you try to use scrollable cursors with a MySQL statement, the PDO::FETCH_ORI_ABS parameter and the offset given to fetch() will be silently ignored. fetch() will behave as normal, returning rows in the order in which they came out of the database.

It's actually pretty confusing behaviour at first. Definitely worth documenting even if only as a user-added note on this page.
up
27
gergo at gergoerdosi dot com
13 years ago
When using PDO::FETCH_COLUMN in a while loop, it's not enough to just use the value in the while statement as many examples show:

<?php
while ($row = $stmt->fetch(PDO::FETCH_COLUMN)) {
    print $row;
}
?>

If there are 5 rows with values 1 2 0 4 5, then the while loop above will stop at the third row printing only 1 2. The solution is to either explicitly test for false:

<?php
while (($row = $stmt->fetch(PDO::FETCH_COLUMN)) !== false) {
    print $row;
}
?>

Or use foreach with fetchAll():

<?php
foreach ($stmt->fetchAll(PDO::FETCH_COLUMN) as $row) {
    print $row;
}
?>

Both will correctly print 1 2 0 4 5.
up
18
lod
18 years ago
A quick one liner to get the first entry returned.  This is nice for very basic queries.

<?php
$count = current($db->query("select count(*) from table")->fetch());
?>php
up
12
public at grik dot net
15 years ago
When fetching an object, the constructor of the class is called after the fields are populated by default.

PDO::FETCH_PROPS_LATE is used to change the behaviour and make it work as expected - constructor be called _before_ the object fields will be populated with the data.

sample:

<?php
$a = $PDO->query('select id from table');
$a->setFetchMode(PDO::FETCH_CLASS|PDO::FETCH_PROPS_LATE, 'ClassName');
$obj = $a->fetch();
?>

http://bugs.php.net/bug.php?id=53394
up
8
Typer85 at gmail dot com
16 years ago
Here is quick note for developers that use the PDO SQLite Driver:

The PDO SQLite driver does not support cursors, so using the PDO::CURSOR_SCROLL Attribute, will not work when using the PDO SQLite driver. For example:

<?php

// Assuming $Handle Is a PDO Handle.
$Statement = $Handle->query( $sqlStatement , array( PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL ) );

?>

What is even worse is that PDO::prepare will NOT throw an Exception when it fails to prepare the query, even when the error mode is set to throw Exceptions, and will instead return a Boolean False!

Not only do I consider this a poor design choice, but also its a real shame that this is not documented anywhere in the manual -- in fact the manual is not clear on what Attributes are supported by which drivers and which are not so developers are left to play a classic game of guess.

I hope this saves some developers some headaches.

Good Luck,
up
2
paulf at quillandmouse dot com
6 years ago
A prior poster indicated that this function returns a NULL when there are no results. This is not true. This function returns an empty array. fetchAll() returns the same.

Also, the documentation specifies what happens on "failure", but doesn't indicate what constitutes a "failure". A "failure" could be where the function returns no results; that is, the query "failed". However, a "failure" is apparently a situation where the PDO error functions would reveal a "failure", as in illegal SQL syntax, or a query on a table which doesn't exist, etc. An empty result is not a "failure". Maybe that's obvious to everyone else, but it wasn't to me.
up
9
Gerard van Beek
18 years ago
If you to use a new instance of a class for a record you can use:

<?php
include_once("user.class");
$sth = $db->prepare("SELECT * FROM user WHERE id = 1");

/* create instance automatically */
$sth->setFetchMode( PDO::FETCH_CLASS, 'user');
$sth->execute();
$user = $sth->fetch( PDO::FETCH_CLASS );
$sth->closeCursor();
print ($user->id);

/* or create an instance yourself and use it */
$user= new user();
$sth->setFetchMode( PDO::FETCH_INTO, $user);
$sth->execute();
$user= $sth->fetch( PDO::FETCH_INTO );
$sth->closeCursor();
print ($user->id);
?>
up
3
lenz_kappov at yahoo dot co dot uk
12 years ago
Because MySQL does not currently support the use of cursors, the $cursor_offset feature cannot work when using PDO to access a MySQL database.

If you are tring to arbitrarily access a specific record or group of records in a MySQL database recordset, you might want to consider using the LIMIT clause of the SELECT statement to achieve this e.g. LIMIT 5,3 to return just the 6th,7th & 8th records - 3 records starting at index 5 (which is the 6th record).
up
4
fh at ez dot no
20 years ago
If you want to use PDO::FETCH_CLASS you need to set it up with setFetchMode first like so:
        $stmt->setFetchMode( PDO::FETCH_CLASS, 'classType', array( 'parameters to constructor' );
        $object = $stmt->fetch( PDO::FETCH_CLASS );
If you ommit this PHP will segfault.
up
3
fh at ez dot no
20 years ago
I can also add that the constructor is run _after_ the data is set on the object if yo use PDO::FETCH_CLASS.
up
1
Black Knight
10 years ago
this is just On reminder note about Second parameter -cursor_oriantation-

PDO::FETCH_ORI_NEXT :-
Fetch the next row in the result set. Valid only for scrollable cursors.

PDO::FETCH_ORI_PRIOR :-
Fetch the previous row in the result set. Valid only for scrollable cursors.

PDO::FETCH_ORI_FIRST :-
Fetch the first row in the result set. Valid only for scrollable cursors.

PDO::FETCH_ORI_LAST :-
Fetch the last row in the result set. Valid only for scrollable cursors.

PDO::FETCH_ORI_ABS :-
Fetch the requested row by row number from the result set. Valid only for scrollable cursors.

PDO::FETCH_ORI_REL :- 
Fetch the requested row by relative position from the current position of the cursor in the result set. Valid only for scrollable cursors.
up
2
marcini
19 years ago
Be careful with fetch() when you use prepared statements and MySQL (I don`t know how it is with other databases). Fetch won`t close cursor and won`t let you send any other query, even if your result set has only one row, . 
If you use $statement->fetch(), you will also have to use $statement->closeCursor() afterwards, to be albe to execute another query.
Alternatively you can use $statement->fetchAll() without $statement->closeCursor().
up
0
Drew
6 years ago
When using a PDOStatement with the fetch mode set to FETCH_CLASS, fetch will return false if no rows were found.
up
-2
lozitskiys at gmail dot com
18 years ago
I spent some hours trying to find out how to manipulate with BLOB fields using PDO.

Remember that you can't retreive BLOB data using something like this :

<?php
$sql = 'SELECT * FROM sometable LIMIT 1';
$stmt = $dbh->prepare($sql);
$stmt->execute();
$stmt->setAttribute(PDO::FETCH_ASSOC);
$row = $stmt->fetch();

$myFile = $row['file'];
?>

Instead of this you should try following approach:

<?php
$sql = "SELECT mime, file FROM sometable LIMIT 1"; 
$stmt = $dbh->prepare($sql); 
$stmt->execute(); 

$stmt->bindColumn(1, $mime,); 
$stmt->bindColumn(2, $file, PDO::PARAM_LOB); 

$stmt->fetch(); 

header('Content-type: '.$mime);
print $file; 

?>
up
-5
Alex
15 years ago
It seems that if you do a $statement->query() with an INSERT statement and after that a $statement->fetch() you will get an exception saying: SQLSTATE[HY000]: General error.
up
-3
sumariva at gmail dot com
14 years ago
I could use PDO::FETCH_COLUMN to retrieve the first column from result.
$ps->fetch( PDO::FETCH_COLUMN );
Worked on Postgresql with PHP 5.3.10.
up
-4
josh
18 years ago
Note that PDO::ATTR_STRINGIFY_FETCHES will NOT work for the MySQL driver. MySQL will always return strings because that is the behaviour of the core mysql PHP extension. See http://bugs.php.net/bug.php?id=44341
up
-3
tastro
12 years ago
Note that this way, the "fetch mode" will get "overwritten", and PDO::FETCH_PROPS_LATE won't be applied:

<?php
$sth = $db->prepare("SELECT * FROM user WHERE id = 1");
$sth->setFetchMode( PDO::FETCH_CLASS|PDO::FETCH_PROPS_LATE, 'user');
$sth->execute();
$user = $sth->fetch( PDO::FETCH_CLASS );
$sth->closeCursor();
?>

Instead, you should leave the parameter area for the fetch() method empty, like this (if you want to set the fetch mode with the setFetchMode() method):

<?php
$sth = $db->prepare("SELECT * FROM user WHERE id = 1");
$sth->setFetchMode( PDO::FETCH_CLASS|PDO::FETCH_PROPS_LATE, 'user');
$sth->execute();
$user = $sth->fetch();
$sth->closeCursor();
?>
up
-3
aledmb at gmail dot com
21 years ago
note that fetch constants are not included in the PDO class for PHP versions prior to 5.1
up
-4
tim at kooky dot org
10 years ago
Be careful when using PDO::FETCH_LAZY.  It adds an additional field called queryString.  I'm not sure if this a bug or not. I'm using version 5.6.17 in Debian Jessie.

Query:  'select 1,2,3'

$row=$smt->fetch(PDO::FETCH_OBJ);
var_dump($row);

object(stdClass)#6 (3) {
  ["1"]=>
  string(1) "1"
  ["2"]=>
  string(1) "2"
  ["3"]=>
  string(1) "3"
}

$row=$smt->fetch(PDO::FETCH_LAZY);
var_dump($row);

object(PDORow)#3 (4) {
  ["queryString"]=>
  string(12) "select 1,2,3"
  ["1"]=>
  string(1) "1"
  ["2"]=>
  string(1) "2"
  ["3"]=>
  string(1) "3"
}
To Top