(PHP 5 >= 5.1.0, PHP 7, PHP 8, PECL pdo >= 0.1.0)
PDOStatement::fetchAll — Devuelve un array que contiene todas las filas del conjunto de resultados
fetch_style
Controla el contenido del array devuelto, tal como está documentado en
PDOStatement::fetch().
El valor predeterminado es PDO::ATTR_DEFAULT_FETCH_MODE
(el cual por defecto es PDO::FETCH_BOTH).
Para devolver un array que contenga todos los valores de una única columna del
conjunto de resultados, se debe especificar PDO::FETCH_COLUMN.
Se puede especificar qué columna se desea obtener con el parámetro
fetch_argument.
Para obtener solamente los valores únicos de una sola columna del conjunto de resultados,
se ha de realizar un OR a nivel de bits de PDO::FETCH_COLUMN con
PDO::FETCH_UNIQUE.
Para devolver un array asociativo agrupado según los valores de una columna
especificada, se ha de realilar un OR a nivel de bits de
PDO::FETCH_COLUMN con PDO::FETCH_GROUP.
fetch_argument
Este argumento tiene un significado diferente dependiendo del valor del
parámetro fetch_style:
PDO::FETCH_COLUMN: Devuelve la columna con el índice
indicado basado en 0.
PDO::FETCH_CLASS: Devuelve instancias de la clase especificada,
haciendo corresponder las columnas de cada fila con las propiedades con nombre de la clase.
PDO::FETCH_FUNC: Devuelve el resultado de llamar a
la función especificada, usando cada columna de fila como parámetro de la llamada.
ctor_args
Los argumentos del constructor de la case cuando el parámetro
fetch_style es PDO::FETCH_CLASS.
PDOStatement::fetchAll() devuelve un array que contiene
todas las filas restantes del conjunto de resultados. El array representa cada
fila como un array con valores de las columnas, o como un objeto con propiedades
correspondientes a cada nombre de columna. Es devuelto un array vacío si hay
cero resultados que obtener, o false en caso de fallo.
Usar este método para obtener conjuntos de resultados grandes dará como resultado una fuerte demanda del sistema y, posiblemente, de los recursos de red. En lugar de recuperar todos los datos y manipularlos en PHP, considérese usar el servidor de bases de datos para manipular los conjuntos de resultados. Por ejemplo, se pueden usar las cláusulas WHERE y ORDER BY en sentencias SQL para restringir el resultado antes de recuperarlos y procesarlos con PHP.
Ejemplo #1 Obtener todas las filas restantes de un conjunto de resultados
<?php
$gsent = $gbd->prepare("SELECT name, colour FROM fruit");
$gsent->execute();
/* Obtener todas las filas restantes del conjunto de resultados */
print("Obtener todas las filas restantes del conjunto de resultados:\n");
$resultado = $gsent->fetchAll();
print_r($resultado);
?>El resultado del ejemplo sería algo similar a:
Obtener todas las filas restantes del conjunto de resultados:
Array
(
[0] => Array
(
[name] => pear
[0] => pear
[colour] => green
[1] => green
)
[1] => Array
(
[name] => watermelon
[0] => watermelon
[colour] => pink
[1] => pink
)
)
Ejemplo #2 Obtener todos los valores de una única columna de un conjunto de resultados
El siguiente ejemplo demuestra cómo devolver todos los valores de una única columna de un conjunto de resultados, incluso si la sentencia SQL podría devolver múltiples columnas por cada fila.
<?php
$gsent = $gbd->prepare("SELECT name, colour FROM fruit");
$gsent->execute();
/* Obtener todos los valores de la primera columna */
$resultado = $gsent->fetchAll(PDO::FETCH_COLUMN, 0);
var_dump($resultado);
?>El resultado del ejemplo sería algo similar a:
Array(3)
(
[0] =>
string(5) => apple
[1] =>
string(4) => pear
[2] =>
string(10) => watermelon
)
Ejemplo #3 Agrupar todos los valores según una única columna
El siguiente ejemplo demuestra cómo devolver un array asociativo
agrupado según los valores de la columna especificada del conjunto de resultados. El
array contiene tres claves: los valores apple y
pear son devueltos como arrays que contienen dos
colores diferentes, mientras que watermelon es
devuelto como un array que contiene un solo color.
<?php
$insert = $gbd->prepare("INSERT INTO fruit(name, colour) VALUES (?, ?)");
$insert->execute(array('apple', 'green'));
$insert->execute(array('pear', 'yellow'));
$gsent = $gbd->prepare("SELECT name, colour FROM fruit");
$gsent->execute();
/* Agrupar valores según la primera columna */
var_dump($gsent->fetchAll(PDO::FETCH_COLUMN|PDO::FETCH_GROUP));
?>El resultado del ejemplo sería algo similar a:
array(3) {
["apple"]=>
array(2) {
[0]=>
string(5) "green"
[1]=>
string(3) "red"
}
["pear"]=>
array(2) {
[0]=>
string(5) "green"
[1]=>
string(6) "yellow"
}
["watermelon"]=>
array(1) {
[0]=>
string(5) "green"
}
}
Ejemplo #4 Instanciar una clase para cada resultado
El siguiente ejemplo demuestra el comportamiento del estilo
de obtención de PDO::FETCH_CLASS.
<?php
class fruit {
public $name;
public $colour;
}
$gsent = $gbd->prepare("SELECT name, colour FROM fruit");
$gsent->execute();
$resultado = $gsent->fetchAll(PDO::FETCH_CLASS, "fruit");
var_dump($resultado);
?>El resultado del ejemplo sería algo similar a:
array(3) {
[0]=>
object(fruit)#1 (2) {
["name"]=>
string(5) "apple"
["colour"]=>
string(5) "green"
}
[1]=>
object(fruit)#2 (2) {
["name"]=>
string(4) "pear"
["colour"]=>
string(6) "yellow"
}
[2]=>
object(fruit)#3 (2) {
["name"]=>
string(10) "watermelon"
["colour"]=>
string(4) "pink"
}
}
Ejemplo #5 Invocar a una función por cada resultado
El siguiente ejemplo demuestra el comportamiento del estilo
de obtención de PDO::FETCH_FUNC.
<?php
function fruit($name, $colour) {
return "{$name}: {$colour}";
}
$gsent = $gbd->prepare("SELECT name, colour FROM fruit");
$gsent->execute();
$resultado = $gsent->fetchAll(PDO::FETCH_FUNC, "fruit");
var_dump($resultado);
?>El resultado del ejemplo sería algo similar a:
array(3) {
[0]=>
string(12) "apple: green"
[1]=>
string(12) "pear: yellow"
[2]=>
string(16) "watermelon: pink"
}
I still don't understand why FETCH_KEY_PAIR is not documented here (http://php.net/manual/fr/pdo.constants.php), because it could be very useful!
<?php
var_dump($pdo->query('select id, name from table')->fetchAll(PDO::FETCH_KEY_PAIR));
?>
This will display:
array(2) {
[2]=>
string(10) "name2"
[5]=>
string(10) "name5"
}Getting foreach to play nicely with some data from PDO FetchAll()
I was not understanding to use the $value part of the foreach properly, I hope this helps someone else.
Example:
<?php
$stmt = $this->db->prepare('SELECT title, FMarticle_id FROM articles WHERE domain_name =:domain_name');
$stmt->bindValue(':domain_name', $domain);
$stmt->execute();
$article_list = $stmt->fetchAll(PDO::FETCH_ASSOC);
?>
which gives:
array (size=2)
0 =>
array (size=2)
'title' => string 'About Cats Really Long title for the article' (length=44)
'FMarticle_id' => string '7CAEBB15-6784-3A41-909A-1B6D12667499' (length=36)
1 =>
array (size=2)
'title' => string 'another cat story' (length=17)
'FMarticle_id' => string '0BB86A06-2A79-3145-8A02-ECF6EA5C405C' (length=36)
Then use:
<?php
foreach ($article_list as $row => $link) {
echo '<a href="'. $link['FMarticle_id'].'">' . $link['title']. '</a></br>';
}
?>Interestingly enough, when you use fetchAll, the constructor for your object is called AFTER the properties are assigned. For example:
<?php
class person {
public $name;
function __construct() {
$this->name = $this->name . " is my name.";
}
}
# set up select from a database here with PDO
$obj = $STH->fetchALL(PDO::FETCH_CLASS, 'person');
?>
Will result in ' is my name' being appended to all the name columns. However if you call it slightly differently:
<?php
$obj = $obj = $STH->fetchAll(PDO::FETCH_CLASS | PDO::FETCH_PROPS_LATE, 'person');
?>
Then the constructor will be called before properties are assigned. I can't find this documented anywhere, so I thought it would be nice to add a note here.PLEASE BE AWARE: If you do an OUTER LEFT JOIN and set PDO FetchALL to PDO::FETCH_ASSOC, any primary key you used in the OUTER LEFT JOIN will be set to a blank if there are no records returned in the JOIN.
For example:
<?php
//query the product table and join to the image table and return any images, if we have any, for each product
$sql = "SELECT * FROM product, image
LEFT OUTER JOIN image ON (product.product_id = image.product_id)";
$array = $stmt->fetchAll(PDO::FETCH_ASSOC);
print_r($array);
?>
The resulting array will look something like this:
Array
(
[0] => Array
(
[product_id] =>
[notes] => "this product..."
[brand] => "Best Yet"
...
The fix is to simply specify your field names in the SELECT clause instead of using the * as a wild card, or, you can also specify the field in addition to the *. The following example returns the product_id field correctly:
<?php
$sql = "SELECT *, product.product_id FROM product, image
LEFT OUTER JOIN image ON (product.product_id = image.product_id)";
$array = $stmt->fetchAll(PDO::FETCH_ASSOC);
print_r($array);
?>
The resulting array will look something like this:
Array
(
[0] => Array
(
[product_id] => 3
[notes] => "this product..."
[brand] => "Best Yet"
...Note that fetchAll() can be extremely memory inefficient for large data sets. My memory limit was set to 160 MB this is what happened when I tried:
<?php
$arr = $stmt->fetchAll();
// Fatal error: Allowed memory size of 16777216 bytes exhausted
?>
If you are going to loop through the output array of fetchAll(), instead use fetch() to minimize memory usage as follows:
<?php
while ($arr = $stmt->fetch()) {
echo round(memory_get_usage() / (1024*1024),3) .' MB<br />';
// do_other_stuff();
}
// Last line for the same query shows only 28.973 MB usage
?>If you want to use PDO::FETCH_CLASS but don't like that all the values are of the type string, you can always use the __construct function of the class specified to convert them to a different type.
Another way is using mysqlnd, but it seems I had to recompile PHP for that.
<?php
class Cdr {
public $a; // int
public $b; // float
public $c; // string
public function __construct() {
$this->a = intval($this->a);
$this->b = floatval($this->b);
}
}
// ...
$arrCdrs = $objSqlStatement->fetchAll(PDO::FETCH_CLASS, 'Cdr');
?>Something missing in the doc.
If for instance you try to fetchAll(PDO::CLASS, "Class") it sometimes return an array of objects with NULL values, but the count of objects fetched correspond to table rows.
In this way works fine:
fetchAll(PDO::FETCH_CLASS | PDO::FETCH_PROPS_LATE, "Class");
For example
$stm = $pdo->prepare("SELECT * FROM Fruit");
$stm->execute();
$stm->fetchAll(PDO::FETCH_CLASS | PDO::FETCH_PROPS_LATE, "Fruit");Note that \PDO::FETCH_DEFAULT was not introduced until PHP 8.0.7 and 8.1.0. It will throw an undefined constant error in earlier versions.Be careful when using PDO::FETCH_COLUMN with PDO::FETCH_GROUP. By default, results are grouped by first column (index 0) and second column (index 1) is returned. But, if you provide fetch argument, it wouldn't affect returned column, but grouping column. If grouping column is set explicitly , first columns is returned instead of second.
<?php
$insert = $dbh->prepare("INSERT INTO people(id, gender) VALUES (?, ?)");
$insert->execute(array('2', 'female'));
$insert->execute(array('3', 'female'));
$insert->execute(array('4', 'female'));
$insert->execute(array('5', 'male'));
$insert->execute(array('6', 'male'));
$sth = $dbh->prepare("SELECT gender, id FROM people");
$sth->execute();
/* Group values by the first column */
var_dump($sth->fetchAll(PDO::FETCH_COLUMN|PDO::FETCH_GROUP));
?>
Returns:
<?php
array (size=2)
'female' =>
array (size=3)
0 => string '2' (length=1)
1 => string '3' (length=1)
2 => string '4' (length=1)
'male' =>
array (size=2)
0 => string '5' (length=1)
1 => string '6' (length=1)
?>
But,
<?php
var_dump($sth->fetchAll(PDO::FETCH_COLUMN|PDO::FETCH_GROUP, 0));
?>
returns:
<?php
array (size=2)
'female' =>
array (size=3)
0 => string 'female' (length=1)
1 => string 'female' (length=1)
2 => string 'female' (length=1)
'male' =>
array (size=2)
0 => string 'male' (length=1)
1 => string 'male' (length=1)
?>
and
<?php
var_dump($sth->fetchAll(PDO::FETCH_COLUMN|PDO::FETCH_GROUP, 1));
?>
returns
<?php
array (size=5)
2 =>
array (size=1)
0 => string 'female' (length=1)
3 =>
array (size=1)
0 => string 'female' (length=1)
4 =>
array (size=1)
0 => string 'female' (length=1)
5 =>
array (size=1)
0 => string 'male' (length=1)
6 =>
array (size=1)
0 => string 'male' (length=1)
?>
First column is retuned and grouping is done by provided column index.I was blown away that you can actually combine PDO::FETCH_CLASS | PDO::FETCH_CLASSTYPE | PDO::FETCH_UNIQUE, because both PDO::FETCH_CLASSTYPE and PDO::FETCH_UNIQUE say they will use the first column, but it turns out PDO::FETCH_CLASSTYPE goes first and then PDO::FETCH_UNIQUE will use the next column. This way you can create an associative array of objects, with one of the table columns as key. For example a query such as
'SELECT Class, Id, t.* FROM subscriptions_tbl t'
might give you this result:
Array
(
[20481086] => WConsumerSubscription Object
(
[Variant] => 2
[_Expiration:WSubscriptionModel:private] => DateTime Object
(
[date] => 2018-08-08 00:00:00.000000
[timezone_type] => 3
[timezone] => UTC
)
[Notes] =>
[Id] => 20481086
[_Deleted:protected] => 0
[_VersionNo:protected] => 2
[ContactId] =>
[ConsumerId] => 2
)
[21878324] => WAdminSubscription Object
(
[Variant] =>
[_Expiration:WSubscriptionModel:private] =>
[Notes] =>
[Id] => 21878324
[_Deleted:protected] => 0
[_VersionNo:protected] => 1
[ContactId] =>
)
)If you use the PDO::FETCH_CLASS | PDO::FETCH_PROPS_LATE flags to map columns to object properties, fetchAll() will use any __set() method your object has when carrying out the mapping.In method body:
return $pstmt->fetchAll() or die("bad");
will not return correct value, but "1" instead.Note, that you can use PDO::FETCH_COLUMN|PDO::FETCH_GROUP pair only while selecting two columns, not like DB_common::getAssoc(), when grouping is set to true.There is also another fetch mode supported on Oracle and MSSQL:
PDO::FETCH_ASSOC
> fetches only column names and omits the numeric index.
If you would like to return all columns from an sql statement with column keys as table headers, it's as simple as this:
<?php
$dbh = new PDO("DS", "USERNAME", "PASSWORD");
$stmt = $dbh->prepare("SELECT * FROM tablename");
$stmt->execute();
$arrValues = $stmt->fetchAll(PDO::FETCH_ASSOC);
// open the table
print "<table wdith=\"100%\">\n";
print "<tr>\n";
// add the table headers
foreach ($arrValues[0] as $key => $useless){
print "<th>$key</th>";
}
print "</tr>";
// display data
foreach ($arrValues as $row){
print "<tr>";
foreach ($row as $key => $val){
print "<td>$val</td>";
}
print "</tr>\n";
}
// close the table
print "</table>\n";
?>There may be some user who needs to upgrade their MySQL class to PDO class. The way of fetching results were changed from while loop into a foreach loop. For the people who wish to fetch the results in a while loop, here is a simple trick.
<?php
$db = new DB();
$query = $db->prepare("SELECT * FROM CPUCategory");
$query = $db->execute();
$result = $db->fetchAll();
var_dump($result);
?>
The Output will be:
array(2) {
[0]=> array(2) {
["ccatid"]=> int(1)
["ccatname"]=> string(5) "Intel"
}
[1]=> array(2) {
["ccatid"]=> int(2)
["ccatname"]=> string(3) "AMD"
}
}
Never look like the output of old function.
[ORIGINAL STYLE] mysql_fetch_array($query)
[ MYSQL CLASS] $db->fetch_array($query)
And you may give up.
But there is a simple way to use while loop to fetch the results.
<?php
$db = new DB();
$query = $db->prepare("SELECT * FROM CPUCategory");
$query = $db->execute();
$result = $db->fetchAll();
$row = array_shift($result);
// If you need to fetch them now, put it in a while loop just like below:
// while($row = array_shift($result)) { ... }
var_dump($row);
?>
The Output will be in a single array with while loop returns TRUE:
array(2) {
["ccatid"]=> int(1)
["ccatname"]=> string(5) "Intel"
}
So after fetching this row, while loop runs again and fetch the next row until all row has fetched, then the while loop will return false. (Just like the old function did)
When you need to upgrade to PDO class, not much code needs to be modified and remember.Error:
SQLSTATE[HY000]: General error: 2014 Cannot execute queries while other unbuffered queries are active. Consider using PDOStatement::fetchAll(). Alternatively, if your code is only ever going to run against mysql, you may enable query buffering by setting the PDO::MYSQL_ATTR_USE_BUFFERED_QUERY attribute.
If you're using something like:
while ($row = $query->fetchObject()) {
[...]
}
try using this instead:
$rows = $query->fetchAll(PDO::FETCH_CLASS, 'ArrayObject');
foreach ($rows as $row) {
[...]
}It's important to note that PDO::FETCH_CLASS does not behave the way you would intuitively expect. Intuitively, you might expect that it either does not call the constructor at all and sets the properties "magically", or that it simply calls the constructor with the data from the database. Both assumptions are incorrect. It *does* call the constructor, but *not* with data from the database; it uses "magic" to set the properties. This can result in problems.
For example, one might intuitively expect code like this to work, perhaps as a starting point for doing Domain-Driven Design without a full-fat ORM. (It doesn't.)
<?php
final class Example{
private static ?PDO $pdo;
private function __construct(
public readonly int $id,
public readonly string $val1,
public readonly ?string $val2,
){}
public static function init(PDO $pdo){
static::$pdo = $pdo;
static::$pdo->exec("
CREATE TABLE IF NOT EXISTS example (
id INT AUTO_INCREMENT PRIMARY KEY,
val1 TEXT NULL,
val2 TEXT NOT NULL
)
");
}
public static function create(string $val1, ?string $val2=null){
if (!isset(static::$pdo)) throw new RuntimeException('Not yet initialized');
$query = static::$pdo->prepare("
INSERT INTO example
(val1, val2)
VALUES
(?, ?)
");
$query->execute([$val1, $val2]);
return static::fetch(static::$pdo->lastInsertId());
}
public static function fetch($id){
if (!isset(static::$pdo)) throw new RuntimeException('Not yet initialized');
$query = static::$pdo->prepare("SELECT * FROM example WHERE id = ?");
$query->execute([$id]);
$result = $query->fetchAll(PDO::FETCH_CLASS, 'Example');
if (!empty($result)) return $result[0];
}
}
?>
For a pattern like this to work, you'll instead need to do one of the following:
1. Use PDO::FETCH_FUNC instead of PDO::FETCH_CLASS, and pass it an anonymous function that calls the constructor.
2. Have a constructor that does nothing, and use the create() method to set properties directly. This would require removing the readonly modifier (though you could use PHP's new asymmetric visibility instead to achieve a similar effect). This also means that you can no longer actually use the constructor to fully construct an object (which, depending on your needs, may or may not be an acceptable compromise). You'll need a private constructor to avoid having partially-constructed objects floating around.
3. Use PDO::FETCH_ASSOC instead of PDO::FETCH_CLASS, then use ReflectionClass::newInstanceWithoutConstructor(), ReflectionObject::getProperty(), and ReflectionProperty::setValue() to implement "magical" class construction yourself.
4. Give up and use Doctrine or some other ORM.
There is, unfortunately, no solution that doesn't either have some compromise, require writing boilerplate code, or require adding a dependency to your project.I am adding this here as I don’t seem to find any clear and easy to find examples and explanations of PDO::FETCH_GROUP and how it works by means of an example.
I find this to be one of the most useful modes available in fetchAll() when you need to work with any form of grouping.
In essence, PDO can group results into nested arrays, based on the first field selected.
Example
<?php
$data = $pdo->query('SELECT sex, name, car FROM users')->fetchAll(PDO::FETCH_GROUP);
/* array (
'male' => array ( 0 =>
array (
'name' => 'John',
'car' => 'Toyota',
),
1 => array (
'name' => 'Mike',
'car' => 'Ford',
),
),
'female' => array (
0 => array (
'name' => 'Mary',
'car' => 'Mazda',
),
1 => array (
'name' => 'Kathy',
'car' => 'Mazda',
),
),
) */
?>
Tip: If you need to group the data by something other than the first field then you can do it like this as well
<?php
SELECT sex, users.* FROM users
?>Method with Return object (PHP 7.2)
class MySql {
public function __construct()
{
parent::__construct();
try{
$options = array
(
PDO::MYSQL_ATTR_INIT_COMMAND => "SET NAMES UTF8"
);
$this->pdo = new PDO('mysql:host=127.0.0.1;dbname=testuser','dbtest', 'xxxxxxx',$options);
$this->pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
}catch(PDOException $e) {
print "Error!: " . $e->getMessage() . "<br/>";
die();
}
}
public function selectAll(string $sql)
{
$conn = $this->pdo->query($sql);
return $conn->fetchAll(PDO::FETCH_OBJ);
}
}