Beschreibung

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

Ruft eine Zeile aus einer Ergebnismenge ab, die mit einem PDOStatement-Objekt verknüpft ist. Der Parameter mode bestimmt, wie PDO die Zeile zurückgibt.

Parameter-Liste

mode

Legt fest, wie die nächste Zeile an die aufrufende Methode zurückgegeben werden soll. Dieser Wert muss eine der PDO::FETCH_*-Konstanten sein. Voreingestellt ist PDO::ATTR_DEFAULT_FETCH_MODE (das standardmäßig auf PDO::FETCH_BOTH gesetzt ist).

PDO::FETCH_ASSOC: gibt ein Array zurück, das durch die Spaltennamen der Ergebnismenge indiziert ist.
PDO::FETCH_BOTH (Voreinstellung): gibt ein Array zurück, das sowohl durch die Spaltennamen der Ergebnismenge als auch durch deren Spaltennummern (beginnend bei 0) indiziert ist.
PDO::FETCH_BOUND: gibt true zurück und weist die Werte der Spalten der Ergebnismenge den PHP-Variablen zu, an die sie mit der Methode PDOStatement::bindColumn() gebunden wurden.
PDO::FETCH_CLASS: gibt eine neue Instanz der angeforderten Klasse zurück. Das Objekt wird initialisiert, indem die Spalten der Ergebnismenge den Eigenschaften der Klasse zugewiesen werden. Dies geschieht vor dem Aufruf des Konstruktors und erlaubt die Belegung von Eigenschaften unabhängig von ihrer Sichtbarkeit oder davon, ob sie als readonly markiert sind. Wenn eine Eigenschaft in der Klasse nicht existiert, wird die magische Methode __set() aufgerufen, falls sie existiert; andernfalls wird eine dynamische öffentliche Eigenschaft erstellt. Wenn jedoch auch PDO::FETCH_PROPS_LATE angegeben ist, wird der Konstruktor vor dem Belegen der Eigenschaften aufgerufen. Wenn mode das Attribut PDO::FETCH_CLASSTYPE enthält (z. B. PDO::FETCH_CLASS | PDO::FETCH_CLASSTYPE), wird der Name der Klasse aus einem Wert der ersten Spalte ermittelt.
PDO::FETCH_INTO: aktualisiert eine bestehende Instanz der angeforderten Klasse, wobei die Spalten der Ergebnismenge den benannten Eigenschaften der Klasse zugeordnet werden.
PDO::FETCH_LAZY: kombiniert PDO::FETCH_BOTH und PDO::FETCH_OBJ und gibt ein PDORow-Objekt zurück, das die Eigenschaftsnamen des Objekts erstellt, wenn auf sie zugegriffen wird.
PDO::FETCH_NAMED: gibt ein Array zurück, das die gleiche Form hat wie PDO::FETCH_ASSOC. Wenn es jedoch mehrere Spalten mit demselben Namen gibt, ist der Wert, auf den der betreffende Schlüssel verweist, ein Array mit allen Werten in der Zeile, die diesen Spaltennamen hatten.
PDO::FETCH_NUM: gibt ein Array zurück, das durch die Spaltennummer aus der Ergebnismenge indiziert ist (beginnend bei Spalte 0).
PDO::FETCH_OBJ: gibt ein anonymes Objekt mit Eigenschaftsnamen zurück, die den Spaltennamen aus der Ergebnismenge entsprechen.
PDO::FETCH_PROPS_LATE: in Kombination mit PDO::FETCH_CLASS wird der Konstruktor der Klasse aufgerufen, bevor die Eigenschaften aus den jeweiligen Spaltenwerten zugewiesen werden.

cursorOrientation

Bei einem PDOStatement-Objekt, das einen scrollbaren Cursor repräsentiert, bestimmt dieser Wert, welche Zeile an die aufrufende Methode zurückgegeben werden soll. Dieser Wert muss eine der PDO::FETCH_ORI_*-Konstanten sein, wobei PDO::FETCH_ORI_NEXT voreingestellt ist. Wenn die SQL-Anweisung mit PDO::prepare() vorbereitet wird, muss das Attribut PDO::ATTR_CURSOR auf PDO::CURSOR_SCROLL gesetzt werden, um einen scrollbaren Cursor für das PDOStatement-Objekt zu erhalten.

cursorOffset

Bei einem PDOStatement-Objekt, das einen scrollbaren Cursor repräsentiert, dessen Parameter cursorOrientation auf PDO::FETCH_ORI_ABS gesetzt ist, gibt dieser Wert die absolute Nummer der Zeile in der Ergebnismenge an, die abgerufen werden soll.

Bei einem PDOStatement-Objekt, das einen scrollbaren Cursor repräsentiert, dessen Parameter cursorOrientation auf PDO::FETCH_ORI_REL gesetzt ist, gibt dieser Wert die abzurufende Zeile relativ zur Position des Zeigers vor dem Aufruf von PDOStatement::fetch() an.

Rückgabewerte

Bei Erfolg hängt der Rückgabewert dieser Funktion von der Art des Abrufs ab. Bei einem Fehler oder wenn es keine weiteren Zeilen gibt, wird in jedem Fall false zurückgegeben.

Fehler/Exceptions

Gibt einen Fehler der Stufe E_WARNING aus, wenn das Attribut PDO::ATTR_ERRMODE auf PDO::ERRMODE_WARNING gesetzt ist.

Löst eine PDOException aus, wenn das Attribut PDO::ATTR_ERRMODE auf PDO::ERRMODE_EXCEPTION gesetzt ist.

Beispiele

Beispiel #1 Abrufen von Zeilen mit verschiedenen Arten des Abrufs

<?php
$sth = $dbh->prepare("SELECT name, colour FROM fruit");
$sth->execute();

/* Beispiele für die verschiedenen Arten von PDOStatement::fetch */
print "PDO::FETCH_ASSOC: ";
print "Die nächste Zeile als Array zurückgeben, das durch den Spaltennamen indiziert ist\n";
$Ergebnis = $sth->fetch(PDO::FETCH_ASSOC);
print_r($result);
print "\n";

print "PDO::FETCH_BOTH: ";
print "Die nächste Zeile als Array zurückgeben, das sowohl durch den Spaltennamen als auch durch die Spaltennummer indiziert ist\n";
$Ergebnis = $sth->fetch(PDO::FETCH_BOTH);
print_r($result);
print "\n";

print "PDO::FETCH_LAZY: ";
print "Die nächste Zeile als PDORow-Objekt mit den Spaltennamen als Eigenschaften zurückgeben\n";
$Ergebnis = $sth->fetch(PDO::FETCH_LAZY);
print_r($result);
print "\n";

print "PDO::FETCH_OBJ: ";
print "Die nächste Zeile als PDORow-Objekt mit den Spaltennamen als Eigenschaften zurückgeben\n";
$result = $sth->fetch(PDO::FETCH_OBJ);
print $result->name;
print "\n";
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

PDO::FETCH_ASSOC: Die nächste Zeile als Array zurückgeben, das durch den Spaltennamen indiziert ist
Array
(
    [name] => apple
    [colour] => red
)

PDO::FETCH_BOTH: Die nächste Zeile als Array zurückgeben, das sowohl durch den Spaltennamen als auch durch die Spaltennummer indiziert ist
Array
(
    [name] => banana
    [0] => banana
    [colour] => yellow
    [1] => yellow
)

PDO::FETCH_LAZY: Die nächste Zeile als anonymes Objekt mit den Spaltennamen als Eigenschaften zurückgeben
PDORow Object
(
    [name] => orange
    [colour] => orange
)

PDO::FETCH_OBJ: Die nächste Zeile als anonymes Objekt mit den Spaltennamen als Eigenschaften zurückgeben
kiwi

Beispiel #2 Abrufen von Zeilen mittels scrollbarem Cursor

<?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 "Vorwärts ausgelesen:\n";
readDataForwards($conn);

print "Rückwärts ausgelesen:\n";
readDataBackwards($conn);
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

Vorwärts ausgelesen:
21    10    5
16    0     5
19    20    10

Rückwärts ausgelesen:
19    20    10
16    0     5
21    10    5

Beispiel #3 Reihenfolge der Konstruktion

Wenn Objekte über PDO::FETCH_CLASS abgerufen werden, werden zuerst die Objekteigenschaften zugewiesen und dann der Konstruktor der Klasse aufgerufen. Wenn jedoch zusätzlich PDO::FETCH_PROPS_LATE angegeben wird, wird diese Reihenfolge umgekehrt, d. h. zuerst wird der Konstruktor aufgerufen und danach werden die Eigenschaften zugewiesen.

<?php
class Person
{
    private $name;

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

    public function tell()
    {
        if (isset($this->name)) {
            echo "Ich heiße {$this->name}.\n";
        } else {
            echo "Ich habe noch keinen Namen.\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();
?>

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

Ich heiße Alice.
Ich heiße Alice.
Ich habe noch keinen Namen.
Ich heiße Bob.

Siehe auch

PDO::prepare() - Bereitet eine Anweisung zur Ausführung vor und liefert ein Anweisungsobjekt
PDOStatement::execute() - Führt ein Prepared Statement aus
PDOStatement::fetchAll() - Ruft die verbleibenden Zeilen aus einer Ergebnismenge ab
PDOStatement::fetchColumn() - Liefert eine einzelne Spalte aus der nächsten Zeile einer Ergebnismenge
PDOStatement::fetchObject() - Ruft die nächste Zeile ab und liefert sie als Objekt
PDOStatement::setFetchMode() - Legt den standardmäßigen Abrufmodus eine Anweisung fest