PHP clase PDOStatement

La clase de PHP PDOStatement representa un prepared statement( sentencia preparada), luego de que la sentencia sea ejecutada con execute esta representara un set de resutados(result set).

Las formas de conseguir un objeto PDOStatement es utilizar uno de los siguientes métodos de la clase PDO: query o prepare.

 class PDOStatement implements IteratorAggregate {
/* Properties */
public string $queryString;
/* 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 debugDumpParams(): ?bool
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 getIterator(): Iterator
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
}

Propiedades

$queryString – es el string que será utilizado

Métodos

La clase PDOStatement nos ofrece métodos los cuales podemos ejecutar para manipular sentencias preparadas (prepared statements), estas son una forma eficiente de ejecutar consultas SQL que se repiten con frecuencia.

bindColumn

Realiza un bind (asocia o vincula) una columna del set de resultados obtenidos con una variable

 public PDOStatement::bindColumn(
    string|int $column,
    mixed &$var,
    int $type = PDO::PARAM_STR,
    int $maxLength = 0,
    mixed $driverOptions = null
): bool

bindParam

vincula un parámetro a una variable específica, cuando estamos hablando de un parámetro, estamos hablando de un parámetro de una consulta SQL

public PDOStatement::bindParam(
    string|int $param,
    mixed &$var,
    int $type = PDO::PARAM_STR,
    int $maxLength = 0,
    mixed $driverOptions = null
): bool

$consulta = $conexion->prepare("SELECT nombre, apellido, edad FROM usuarios WHERE nombre = :name");

$consulta = $conexion->prepare("SELECT nombre, apellido, edad FROM usuarios WHERE nombre = ?");

bindValue

Asocia un valor a un parámetro

public PDOStatement::bindValue(string|int $param, mixed $value, int $type = PDO::PARAM_STR): bool

closeCursor

Cierra el cursor, permitiendo que se ejecute nuevamente una declaración.

Este método existe debido a que algunos drivers no soportan ejecutar un PDOStatement object cuando un objeto PDOStatement previo no termino de obtener las filas en el resultset. En caso de que este sea el caso, tendrás un error out-of-sequence y deberas utilizar closeCursor.

En los casos de los drivers de MySQL, PostgreSQL, SQLite, es probable que no necesites relizar un closeCursor

public PDOStatement::closeCursor(): bool

columnCount

Retorna el número de columnas del resultado obtenido luego de la ejecución de una consulta(result set)

public PDOStatement::columnCount(): int

$sentencia->columnCount();

debugDumpParams

Vuelca un comando preparado de SQL. Tal como su nombre indica, sirve para hacer debug sobre una consulta para identificar algún problema

public PDOStatement::debugDumpParams(): void

errorCode

Obtiene el SQLSTATE asociado con la última operación en el gestor de sentencia

public PDOStatement::errorCode(): string

errorInfo

Obtiene información del error asociado con la última operación del gestor de sentencia en forma de array

public PDOStatement::errorInfo(): array

los elementos del array contendrán la siguiente información:

execute

Ejecuta una sentencia preparada realizada con PDO::prepare(), el método execute puede recibir como parámetros los valores para los placeholders en forma de array el cual puede ser asociativo o numérico dependiendo del placeholder utilizado :name o ? respectivamente.

public PDOStatement::execute(array $input_parameters = ?): bool

$sentencia->execute();
$sentencia->execute($parameters);

//caso en que los placeholders esten marcados por ?
$inputs_parameter=array("juan","bolivia");

//caso en que los placeholders esten marcados por ?
$inputs_parameter=array(":name"=>"juan",":pais"=>"bolivia");

fetch

obtiene la próxima fila que se encuentra en el resultado (resultset)

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

fetchAll

Obtiene todas las filas que aún queden en el result set.

public PDOStatement::fetchAll(int $mode = PDO::FETCH_DEFAULT): array
public PDOStatement::fetchAll(int $mode = PDO::FETCH_COLUMN, int $column): array
public PDOStatement::fetchAll(int $mode = PDO::FETCH_CLASS, string $class, ?array $constructorArgs): array
public PDOStatement::fetchAll(int $mode = PDO::FETCH_FUNC, callable $callback): array

Parámetros

$mode – controla el contenido de el array retornado como en el metodo fetch, su valor por defecto es PDO::FETCH_BOTH

PDO::FETCH_COLUMN retornará un array constituido por todos los valores de una sola columna, deberás especificar que columna con el parámetro $column.

Puedes obtener los resultados únicos de una columna combinando con PDO::FETCH_UNIQUE esto lo puedes hacer utilizando |

$resultados = $stmt->fetchAll(PDO::FETCH_COLUMN | PDO::FETCH_UNIQUE)

Para devolver un array asociativo agrupado por los valores de una columna específica, puedes combinar PDO::FETCH_COLUMN y PDO::FETCH_GROUP con |. Los siguientes son parámetros dinámicos que dependen del modo de obtención. No pueden ser utilizados con parámetros nombrados.

$resultados = $stmt->fetchAll(PDO::FETCH_COLUMN | PDO::FETCH_GROUP);

Retornos

array – retorna un array dependiendo del modo utilizando en $mode

fetchColumn

Retorna una sola columna de la siguiente fila en el set de resultados (resultset)

public PDOStatement::fetchColumn(int $column_number = 0): mixed

fetchObject

obtiene la siguiente fila dando como retorno un objeto que la representara.

 public PDOStatement::fetchObject(?string $class = "stdClass", array $constructorArgs = []): object|false

getAttribute

Obtine un atributo de una sentencia, actualmente no existen atributos genericos pero si tenemos los atributos del driver constantes PDO::ATTR_*.

public PDOStatement::getAttribute(int $name): mixed

getColumnMeta

obtiene la metadata de una columna de un resultset

public PDOStatement::getColumnMeta(int $column): array|false

getIterator

obtiene un objeto Iterator que permite hacer iteraciones sobre el resultset

public PDOStatement::getIterator(): Iterator

En teoria puedes hacer algo como esto con getIterator. No he probado este metodo pero talvez lo hagamos en el futuro

// Conectarse a la base de datos
$pdo = new PDO("mysql:host=localhost;dbname=mi_base_de_datos", "usuario", "contraseña");

// Preparar la consulta
$sql = "SELECT * FROM usuarios";
$stmt = $pdo->prepare($sql);

// Ejecutar la consulta
$stmt->execute();

// Obtener el objeto Iterator
$iterator = $stmt->getIterator();

// Iterar sobre el conjunto de resultados
while ($iterator->valid()) {
    // Obtener el elemento actual
    $row = $iterator->current();

    // Imprimir el elemento actual
    echo $row["id"] . " - " . $row["name"] . PHP_EOL;

    // Avanzar al siguiente elemento
    $iterator->next();
}

nextRowset

Avanza a la proxima fila en un resultado obtenido al correr una sentencia que da como resultado multiples filas(fetchall por ejemplo)

public PDOStatement::nextRowset(): bool

rowCount

Retorna el numero de filas afetadas por la ultima sentencia SQL

public PDOStatement::rowCount(): int

setAttribute

Establece un atributo de sentencia, Este atributo puede ser cualquier constante PDO::ATTR_*

public PDOStatement::setAttribute(int $attribute, mixed $value): bool

setFetchMode

Configura el modo de fetch(obtención) para la sentencia actual. Por lo general esto lo hacemos directamente cuando llamamos fetch, pero tenga en cuenta que también lo podemos hacer de esta manera. Este método tiene relevancia al hacer múltiples consultas.

public PDOStatement::setFetchMode(int $mode): bool
public PDOStatement::setFetchMode(int $mode = PDO::FETCH_COLUMN, int $colno): bool
public PDOStatement::setFetchMode(int $mode = PDO::FETCH_CLASS, string $class, ?array $constructorArgs = null): bool
public PDOStatement::setFetchMode(int $mode = PDO::FETCH_INTO, object $object): bool