The PDOStatement class

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

Introduction

Represents a prepared statement and, after the statement is executed, an associated result set.

Class synopsis

class PDOStatement implements IteratorAggregate {
/* Properties */
/* Methods */
public bindColumn(
    string|int $column,
    mixed &$var,
    int $type = PDO::PARAM_STR,
    int $maxLength = 0,
    mixed $driverOptions = null
): bool
public bindParam(
    string|int $param,
    mixed &$var,
    int $type = PDO::PARAM_STR,
    int $maxLength = 0,
    mixed $driverOptions = null
): bool
public bindValue(string|int $param, mixed $value, int $type = PDO::PARAM_STR): bool
public closeCursor(): bool
public columnCount(): int
public errorCode(): ?string
public errorInfo(): array
public execute(?array $params = null): bool
public fetch(int $mode = PDO::FETCH_DEFAULT, int $cursorOrientation = PDO::FETCH_ORI_NEXT, int $cursorOffset = 0): mixed
public fetchAll(int $mode = PDO::FETCH_DEFAULT): array
public fetchAll(int $mode = PDO::FETCH_COLUMN, int $column): array
public fetchAll(int $mode = PDO::FETCH_CLASS, string $class, ?array $constructorArgs): array
public fetchAll(int $mode = PDO::FETCH_FUNC, callable $callback): array
public fetchColumn(int $column = 0): mixed
public fetchObject(?string $class = "stdClass", array $constructorArgs = []): object|false
public getAttribute(int $name): mixed
public getColumnMeta(int $column): array|false
public nextRowset(): bool
public rowCount(): int
public setAttribute(int $attribute, mixed $value): bool
public setFetchMode(int $mode): bool
public setFetchMode(int $mode = PDO::FETCH_COLUMN, int $colno): bool
public setFetchMode(int $mode = PDO::FETCH_CLASS, string $class, ?array $constructorArgs = null): bool
public setFetchMode(int $mode = PDO::FETCH_INTO, object $object): bool
}

Properties

queryString

Used query string.

Changelog

Version Description
8.0.0 PDOStatement implements IteratorAggregate now instead of Traversable.

Table of Contents

add a note

User Contributed Notes 2 notes

up
17
Gino D.
6 years ago
I don't know why PDOStatement don't return "execution time" and "found rows" so here I created an extended class of PDOStatement with these attributes.

Just have to "setAttribute" of PDO's object to $PDO->setAttribute(\PDO::ATTR_STATEMENT_CLASS , ['\customs\PDOStatement', [&$this]]);

<?php

/**
*
*
*
*/

namespace customs;

/**
*
*
*
*/

final class PDOStatement extends \PDOStatement {

/**
*
*
*
*/

protected $PDO = null;
protected
$inputParams = [];
protected
$executionTime = 0;
protected
$resultCount = 0;

/**
*
*
*
*/

protected function __construct(PDO &$PDO) {
$this->PDO = $PDO;
$this->executionTime = microtime(true);
}

/**
*
*
*
*/

final public function getExecutionError(int $i = 2) {
$executionError = $this->errorInfo();

if (isset(
$executionError[$i]))
return
$executionError[$i];

return
$executionError;
}

/**
*
*
*
*/

final public function getExecutionTime($numberFormat = false, $decPoint = '.', $thousandsSep = ',') {
if (
is_numeric($numberFormat))
return
number_format($this->executionTime, $numberFormat, $decPoint, $thousandsSep);

return
$this->executionTime;
}

/**
*
*
*
*/

final public function getResultCount($numberFormat = false, $decPoint = '.', $thousandsSep = ',') {
if (
is_numeric($numberFormat))
return
number_format($this->resultCount, $numberFormat, $decPoint, $thousandsSep);

return
$this->resultCount;
}

/**
*
*
*
*/

final public function getLastInsertId() {
return
$this->PDO->lastInsertId();
}

/**
*
*
*
*/

final public function bindValues(array $inputParams) {
foreach (
$this->inputParams = array_values($inputParams) as $i => $value) {
$varType = is_null($value) ? \PDO::PARAM_NULL : is_bool($value) ? \PDO::PARAM_BOOL : is_int($value) ? \PDO::PARAM_INT : \PDO::PARAM_STR;

if (!
$this->bindValue(++ $i, $value, $varType))
return
false;
}

return
true;
}

/**
*
*
*
*/

final public function execute($inputParams = null) {
if (
$inputParams)
$this->inputParams = $inputParams;

if (
$executed = parent::execute($inputParams))
$this->executionTime = microtime(true) - $this->executionTime;

return
$executed;
}

/**
*
*
*
*/

final public function fetchAll($how = null, $className = null, $ctorArgs = null) {
$resultSet = parent::fetchAll(... func_get_args());

if (!empty(
$resultSet)) {
$queryString = $this->queryString;
$inputParams = $this->inputParams;

if (
preg_match('/(.*)?LIMIT/is', $queryString, $match))
$queryString = $match[1];

$queryString = sprintf('SELECT COUNT(*) AS T FROM (%s) DT', $queryString);

if ((
$placeholders = substr_count($queryString, '?')) < count($inputParams))
$inputParams = array_slice($inputParams, 0, $placeholders);

if ((
$sth = $this->PDO->prepare($queryString)) && $sth->bindValues($inputParams) && $sth->execute())
$this->resultCount = $sth->fetchColumn();

$sth = null;
}

return
$resultSet;
}
}
?>
up
3
nmurzin at mail dot ru
3 years ago
I think I found a way to execute a protected SQL query and at the same time find out the number of affected records.
I have the table 'tbl_users' with the following fields: id, login, password, age

<?
const DB_DRIVER = "mysql";
const DB_HOST = "localhost";
const DB_NAME = "my_db_name";
const DB_LOGIN = "root";
const DB_PASS = "root"; //OpenServer.

$connectionString = DB_DRIVER.':host='.DB_HOST.';dbname='.DB_NAME;
try
{
//Connect to database.
$db = new PDO($connectionString, DB_LOGIN, DB_PASS);
}
catch(PDOException $e)
{
die("Error: ".$e->getMessage());
}
$db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);

try
{

//Decreasing age for user 'nick1'.
$prep1 = $db->prepare("UPDATE tbl_users SET age=age-1 WHERE login='nick1'");

//Increasing age for user 'nick2'.
$prep2 = $db->prepare("UPDATE tbl_users SET \r\n age=age+1 WHERE login='nick2'");

//Start transaction.
$db->beginTransaction(); //Table type must be InnerDB!

//We assume that everything will be fine.
$flagDone = true;

//The exec() method returns the number of rows affected by the query.
//$prep1->queryString is already an escaped SQL string.
$result = $db->exec($prep1->queryString);
if($result==false || $result!=1) //var_dump($result) - int(1) or bool(false).
$flagDone = false;

$result = $db->exec($prep2->queryString);
if($result==false || $result!=1)
$flagDone = false;

if($flagDone)
{
if($db->commit())
echo "Transaction was successful";
}
else{
echo "Transaction fail";
$db->rollback();
}
echo "<br>";

}
catch(PDOException $e)
{
die("Error: ".$e->getMessage());
}
To Top