PDOStatement::closeCursor
(PHP 5 >= 5.1.0, PHP 7, PHP 8, PECL pdo >= 0.9.0)
PDOStatement::closeCursor —
Ferme le curseur, permettant à la requête d'être de nouveau exécutée
Description
public PDOStatement::closeCursor():
bool
Cette méthode est utile pour les drivers de base de données qui ne supportent
pas l'exécution d'objet PDOStatement lorsqu'un objet PDOStatement exécuté
précédemment a encore des lignes non récupérées. Si votre driver de base de
données souffre de cette limitation, le problème se manifestera de lui-même
dans une erreur en dehors de la séquence.
PDOStatement::closeCursor() est implémenté soit
en tant que méthode optionnelle spécifique au pilote, avec un maximum
d'efficacité, ou en tant que solution générique si aucune fonction
spécifique au pilote n'est installée.
Sémantiquement, la fonction générique PDO revient à
écrire le code suivant dans votre script PHP :
<?php
do {
while ($stmt->fetch())
;
if (!$stmt->nextRowset())
break;
} while (true);
?>
Liste de paramètres
Cette fonction ne contient aucun paramètre.
Valeurs de retour
Cette fonction retourne true
en cas de succès ou false
si une erreur survient.
Erreurs / Exceptions
Émet une erreur de niveau E_WARNING
si l'attribut PDO::ATTR_ERRMODE
est défini
à PDO::ERRMODE_WARNING
.
Lève une exception PDOException si l'attribut PDO::ATTR_ERRMODE
est défini
à PDO::ERRMODE_EXCEPTION
.
Exemples
Exemple #1 Exemple avec PDOStatement::closeCursor()
Dans l'exemple suivant, l'objet PDOStatement $stmt
retourne de multiples lignes, mais l'application récupère uniquement
la première ligne, laissant l'objet PDOStatement dans l'état où il lui reste
des lignes non récupérées. Pour vous assurez que l'application fonctionnera
avec tous les drivers de base de données, l'auteur insère un appel à la fonction
PDOStatement::closeCursor() sur
$stmt avant l'exécution d'objet PDOStatement
$otherStmt.
<?php
/* Création d'un objet PDOStatement */
$stmt = $dbh->prepare('SELECT foo FROM bar');
/* Création d'un second objet PDOStatement */
$otherStmt = $dbh->prepare('SELECT foobaz FROM foobar');
/* Exécute la première requête */
$stmt->execute();
/* Récupération de la première ligne uniquement depuis le résultat */
$stmt->fetch();
/* L'appel suivant à closeCursor() peut être requis par quelques drivers */
$stmt->closeCursor();
/* Maintenant, nous pouvons exécuter la deuxième requête */
$otherStmt->execute();
?>