Documentation

Zend_Db_Select - Zend_Db

Zend_Db_Select

Einführung

Das Zend_Db_Select-Objekt repräsentiert ein SQL-SELECT-Anfrage-Statement. Die Klasse bietet Methoden um einzelne Teile der Anfrage hinzuzufügen. Einzelne Teile der Anfrage können mit Hilfe von PHP Methoden und Datenstrukturen angegeben werden, und die Klasse erzeugt korrekte SQL-Syntax. Nachdem die Anfrage formuliert wurde, kann sie ausgeführt werden, als wäre sie mit einem normalen String geschrieben worden.

Zend_Db_Select bietet folgenden Nutzen:

  • Objektorientierte Methoden um SQL-Anfragen Stück für Stück zu formulieren.

  • Datenbankunabhängige Abstraktion einiger Teile der SQL-Anfrage.

  • In den meisten Fällen automatische Quotierung von Metadaten um zu erlauben, dass Bezeichner reservierte SQL-Wörter und spezielle Zeichen enthalten dürfen.

  • Quotierung von Bezeichnern und Werten, um das Risiko von Angriffen durch SQL-Injektion zu verringern.

Nutzung von Zend_Db_Select ist nicht zwingend erforderlich. Für einfache SELECT-Anfragen ist es normalerweise einfacher, die gesamte SQL-Anfrage in einem String zu formulieren und mit Hilfe der Methoden der Adapterklasse, wie query() oder fetchAll(), auszuführen. Die Nutzung von Zend_Db_Select ist hilfreich, wenn eine SELECT-Anfrage prozedural oder basierend auf der konditionellen Logik der Anwendung zusammengesetzt wird.

Erzeugung eines Select-Objekts

Die Instanz eines Zend_Db_Select-Objekts kann mit Hilfe der Methode select() des Zend_Db_Adapter_Abstract-Objekts erzeugt werden.

Example #1 Beispiel für die Nutzung der Methode select() der Datenbankadapterklasse

  1. $db = Zend_Db::factory( ...Optionen... );
  2. $select = $db->select();

Ein anderer Weg ein Zend_Db_Select-Objekt zu erzeugen, ist die Nutzung des Konstruktors unter Angabe des Datenbankadapters als Argument.

Example #2 Beispiel für die Erzeugung eines Select-Objekts

  1. $db = Zend_Db::factory( ...Optionen... );
  2. $select = new Zend_Db_Select($db);

Erstellung von Select-Anfragen

Wenn die Anfrage erstellt wird, können Bedingungen der Anfrage nacheinander hinzugefügt werden. Es gibt separate Methoden für das Hinzufügen von verschiedenen Bedingungen zum Zend_Db_Select-Objekt.

Example #3 Beispiele für die Nutzung der Methoden zum Hinzufügen von Bedingungen

  1. // Erzeugung des Zend_Db_Select-Objekts
  2. $select = $db->select();
  3.  
  4. // Hinzufügen einer FROM Bedingung
  5. $select->from( ...Angabe von Tabelle und Spalten... )
  6.  
  7. // Hinzufügen einer WHERE Bedingung
  8. $select->where( ...Angabe von Suchkriterien... )
  9.  
  10. // Hinzufügen einer ORDER BY Bedingung
  11. $select->order( ...Angabe von Sortierkriterien... );

Die meisten Methoden des Zend_Db_Select-Objekts lassen sich auch über das bequeme Fluent Interface nutzen. Fluent Interface bedeutet, dass jede Methode eine Referenz auf das aufrufende Objekt zurück gibt, daher kann direkt eine andere Methode aufgerufen werden.

Example #4 Beispiel für die Nutzung des Fluent Interface

  1. $select = $db->select()
  2.     ->from( ...Angabe von Tabelle und Spalten... )
  3.     ->where( ...Angabe von Suchkriterien... )
  4.     ->order( ...Angabe von Sortierkriterien... );

Die Beispiele in diesem Abschnitt zeigen die Nutzung des Fluent Interface, es kann aber auch immer das normale Interface verwendet werden. Häufig ist es nötig das normale Interface zu nutzen, zum Beispiel wenn die Anwendung vor dem Hinzufügen der Bedingung Berechnungen durchführen muss.

Hinzufügen eines FROM Abschnitts

Um die Tabelle für die Anfrage anzugeben, wird die Methode from() verwendet. Der Tabellenname kann als einfacher String übergeben werden. Zend_Db_Select wendet Quotierung auf Bezeichner an, es können also auch spezielle Zeichen verwendet werden.

Example #5 Beispiel für die Methode from()

  1. // Erstellen dieser Anfrage:
  2. //   SELECT *
  3. //   FROM "products"
  4.  
  5. $select = $db->select()
  6.              ->from('products');

Es kann auch der Beziehungsname (auch Aliasname genannt) einer Tabelle angegeben werden. Anstelle eines einfachen Strings muss dann ein assoziatives Array übergeben werden, welches den Beziehungsnamen dem tatsächlichen Tabellennamen zuordnet. In anderen Bedingungen der SQL-Anfrage kann dann dieser Beziehungsname verwendet werden. Wenn die Anfrage mehr als eine Tabelle verbindet, generiert Zend_Db_Select eindeutige Beziehungsnamen basierend auf den Tabellennamen, wenn keine Beziehungsnamen angegeben wurden.

Example #6 Beispiel für das Angeben eines Beziehungsnamens

  1. // Erzeugt diese Anfrage:
  2. //   SELECT p.*
  3. //   FROM "products" AS p
  4.  
  5. $select = $db->select()
  6.              ->from(array('p' => 'products'));

Einige RDBMS-Marken unterstützen einen voran stehenden Schemenbezeichner für eine Tabelle. Der Tabellenname kann mit "schemaName.tabellenName" angegeben werden, Zend_Db_Select quotiert die einzelnen Teile für sich. Der Schemaname kann aber auch separat angegeben werden. Ein Schemaname, der mit dem Tabellennamen angegeben wurde, bekommt Vorrang, falls beides angegeben wurde.

Example #7 Beispiel für das Angeben eines Schemanamens

  1. // Erzeut diese Anfrage:
  2. //   SELECT *
  3. //   FROM "myschema"."products"
  4.  
  5. $select = $db->select()
  6.              ->from('myschema.products');
  7.  
  8. // oder
  9.  
  10. $select = $db->select()
  11.              ->from('products', '*', 'myschema');

Hinzufügen von Spalten

Im zweiten Argument der Methode from() kann angegeben werden, welche Spalten der Tabelle ausgelesen werden sollen. Werden keine Spalten angegeben, so gilt der Standardwert *, der SQL Platzhalter für alle Spalten.

Die Spalten können in einem einfachen Array von Strings oder einem assoziativen Array, in dem Aliasnamen den Spaltennamen zugewiesen werden, angegeben werden. Soll nur eine einzelne Spalte ohne Aliasnamen ausgelesen werden, so kann auch ein einfacher String übergeben werden.

Wird ein leeres Array übergeben, so werden auch keine Spalten der Tabelle in den Ergebnissatz aufgenommen. Ein Codebeispiel gibt es unter Codebeispiel bei der Methode join().

Der Spaltenname kann mit "beziehungsName.spaltenName" angegeben werden. Zend_Db_Select quotiert die einzelnen Teile für sich. Wird kein Beziehungsname für die Spalte angegeben, dann wird der Beziehungsname der Tabelle der aktuellen Methode from() verwendet.

Example #8 Beispiele für das Angeben von Spalten

  1. // Erzeugt diese Anfrage:
  2. //   SELECT p."product_id", p."product_name"
  3. //   FROM "products" AS p
  4.  
  5. $select = $db->select()
  6.              ->from(array('p' => 'products'),
  7.                     array('product_id', 'product_name'));
  8.  
  9. // Erzeugt dieselbe Anfrage, Angabe von Beziehungsnamen:
  10. //   SELECT p."product_id", p."product_name"
  11. //   FROM "products" AS p
  12.  
  13. $select = $db->select()
  14.              ->from(array('p' => 'products'),
  15.                     array('p.product_id', 'p.product_name'));
  16.  
  17. // Erzeugt diese Anfrage mit einem Alias für eine Spalte:
  18. //   SELECT p."product_id" AS prodno, p."product_name"
  19. //   FROM "products" AS p
  20.  
  21. $select = $db->select()
  22.              ->from(array('p' => 'products'),
  23.                     array('prodno' => 'product_id', 'product_name'));

Hinzufügen von Spalten mit Ausdrücke

Spalten in einer SQL-Anfrage sind manchmal Ausdrücke, keine einfachen Spaltennamen einer Tabelle. Ausdrücke dürfen keine Beziehungsnamen oder Quotierungen bekommen. Wenn der Spaltenstring runde Klammern enthält, erkennt Zend_Db_Select dies als Ausdruck.

Es kann auch ein Objekt des Typs Zend_Db_Expr erzeugt werden um zu verhindern, dass ein String wie ein Spaltenname behandelt wird. Zend_Db_Expr ist eine Minimalklasse, die einen String enthält. Zend_Db_Select erkennt Objekte des Typs Zend_Db_Expr und konvertiert diese in Strings, nimmt aber keine Änderungen daran vor, wie Quotierung oder Beziehungsnamen.

Note: Die Benutzung von Zend_Db_Expr für Spaltennamen ist nicht nötig, wenn die Spaltennamen Ausdrücke runde Klammern enthalten. Zend_Db_Select erkennt diese und behandelt den String als Ausdruck und lässt Quotierung und Beziehungsnamen aus.

Example #9 Beispiel für das Angeben von Spaltennamen, die Ausdrücke enthalten

  1. // Erzeugt diese Anfrage:
  2. //   SELECT p."product_id", LOWER(product_name)
  3. //   FROM "products" AS p
  4. // Ein Ausdruck eingeschlossen von runden Klammern wird zu Zend_Db_Expr.
  5.  
  6. $select = $db->select()
  7.              ->from(array('p' => 'products'),
  8.                     array('product_id', 'LOWER(product_name)'));
  9.  
  10. // Erzeugt diese Anfrage:
  11. //   SELECT p."product_id", (p.cost * 1.08) AS cost_plus_tax
  12. //   FROM "products" AS p
  13.  
  14. $select = $db->select()
  15.              ->from(array('p' => 'products'),
  16.                     array('product_id',
  17.                           'cost_plus_tax' => '(p.cost * 1.08)'));
  18.  
  19. // Erzeugt diese Anfrage unter ausdrücklicher Verwendung  von Zend_Db_Expr:
  20. //   SELECT p."product_id", p.cost * 1.08 AS cost_plus_tax
  21. //   FROM "products" AS p
  22.  
  23. $select = $db->select()
  24.              ->from(array('p' => 'products'),
  25.                     array('product_id',
  26.                           'cost_plus_tax' =>
  27.                               new Zend_Db_Expr('p.cost * 1.08'))
  28.                     );

In den oben stehenden Fällen ändert Zend_Db_Select den String nicht mit Beziehungsnamen oder Bezeichnerquotierung. Wenn diese Änderungen notwendig sein sollten um Doppeldeutigkeiten aufzulösen, muss dies manuell am String geändert werden.

Wenn die Spaltennamen aus SQL-Schlüsselwörtern bestehen oder spezielle Zeichen enthalten, sollte die Methode quoteIdentifier() verwendet werden und der Rückgabewert in den String eingefügt werden. Die Methode quoteIdentifier() verwendet SQL-Quotierung um Bezeichner abzugrenzen, wodurch klar wird, dass es sich um einen Bezeichner für eine Tabelle oder Spalte handelt, und nicht um einen anderen Teil der SQL-Syntax.

Der Code wird datenbankunabhängiger, wenn die Methode quoteIdentifier() anstelle von direkter Eingabe der Quotierungszeichen verwendet wird, da einige RDBMS-Marken nicht-Standard Symbole für die Quotierung von Bezeichnern verwenden. Die Methode quoteIdentifier() wählt die passenden Quotierungssymbole für den Adaptertyp aus. Die Methode quoteIdentifier() ersetzt außerdem alle Quotierungszeichen innerhalb des Bezeichners.

Example #10 Beispiel für die Quotierung von Spalten in einem Ausdruck

  1. // Erzeugt folgende Anfrage und quotiert dabei einen Spaltennamen
  2. // "from" im Ausdruck:
  3. //   SELECT p."from" + 10 AS origin
  4. //   FROM "products" AS p
  5.  
  6. $select = $db->select()
  7.              ->from(array('p' => 'products'),
  8.                     array('origin' =>
  9.                           '(p.' . $db->quoteIdentifier('from') . ' + 10)')
  10.                    );

Spalten zu einer existierenden FROM oder JOIN Tabelle hinzufügen

Es kann Fälle geben, in denen es gewünscht ist, Spalten zu einer bestehenden FROM- oder JOIN-Tabelle hinzuzufügen, nachdem diese Methoden aufgerufen wurden. Die Methode columns() erlaubt es spezifische Spalten an jedem Punkt hinzuzufügen, bevor die Abfrage aufgeführt wird. Die Spalte kann entweder als String oder Zend_Db_Expr oder als Array dieser Elemente angegeben werden. Das zweite Argument dieser Methode kann unterdrückt werden, was impliziert, dass die Spalten zu der FROM-Tabelle hinzugefügt werden sollen, andernfall muß ein bestehender Korrelationsname verwendet werden.

Example #11 Beispiel für das Hinzufügen von Spalten mit der Methode columns()

  1. // Diese Abfrage bauen:
  2. //   SELECT p."product_id", p."product_name"
  3. //   FROM "products" AS p
  4.  
  5. $select = $db->select()
  6.              ->from(array('p' => 'products'), 'product_id')
  7.              ->columns('product_name');
  8.  
  9. // Dieselbe Abfrage bauen, durch Angabe der Korrelationsnamen:
  10. //   SELECT p."product_id", p."product_name"
  11. //   FROM "products" AS p
  12.  
  13. $select = $db->select()
  14.              ->from(array('p' => 'products'), 'p.product_id')
  15.              ->columns('product_name', 'p');
  16.              // Alternativ kann columns('p.product_name') verwendet werden

Hinzufügen einer weiteren Tabelle zu der Anfrage mit JOIN

Viele nützliche Anfragen benötigen ein JOIN um mehrere Spalten verschiedener Tabellen miteinander zu kombinieren. Tabellen können zu einer Zend_Db_Select-Anfrage mit der Methode join() hinzugefügt werden. Die Nutzung dieser Methode ist ähnlich der Methode from(), außer dass in den meisten Fällen zusätzlich eine Join-Bedingung angegeben werden kann.

Example #12 Beispiel für die Methode join()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT p."product_id", p."product_name", l.*
  3. //   FROM "products" AS p JOIN "line_items" AS l
  4. //     ON p.product_id = l.product_id
  5.  
  6. $select = $db->select()
  7.              ->from(array('p' => 'products'),
  8.                     array('product_id', 'product_name'))
  9.              ->join(array('l' => 'line_items'),
  10.                     'p.product_id = l.product_id');

Das zweite Argument der Methode join() ist ein String mit der Join-Bedingung. Dies ist ein Ausdruck die Kriterien angibt, welche Zeilen in der einen Tabelle mit Zeilen einer anderen Tabelle verknüpft werden. Es können Beziehungsnamen in diesem Ausdruck verwendet werden.

Note: Es wird keine Quotierung auf den Ausdruck für die Join-Bedingung angewendet. Werden Spaltennamen verwendet, welche Quotierung benötigen, so muss quoteIdentifier() verwendet werden, wenn der String für die Join-Bedingung formuliert wird.

Das dritte Argument für join() ist ein Array von Spaltennamen, entsprechend des Arrays der Methode from(). Der Standard ist ebenfalls "*" und unterstützt Beziehungsnamen, Ausdrücke und Zend_Db_Expr in der gleichen Weise wie dem Array von Spaltennamen der Methode from().

Wenn keine Spalten einer Tabelle ausgewählt werden soll, muss ein leeres Array für die Liste der Spaltennamen übergeben werden. Diese Nutzung funktioniert ebenfalls in der Methode from(), aber normalerweise werden einige Spalten der primären Tabelle in den Anfragen benötigt, während möglicherweise keine Spalten der verbundenen Tabelle ausgewählt werden sollen.

Example #13 Beispiel für das Angeben keiner Spalten

  1. // Erzeugt diese Anfrage:
  2. //   SELECT p."product_id", p."product_name"
  3. //   FROM "products" AS p JOIN "line_items" AS l
  4. //     ON p.product_id = l.product_id
  5.  
  6. $select = $db->select()
  7.              ->from(array('p' => 'products'),
  8.                     array('product_id', 'product_name'))
  9.              ->join(array('l' => 'line_items'),
  10.                     'p.product_id = l.product_id',
  11.                     array() ); // leere Liste von Spalten

Zu beachten ist, dass leere array() in dem oben stehenden Beispiel, an der Stelle einer Liste von Spalten der verbundenen Tabelle.

SQL kennt verschiedene Varianten von Joins. In der Liste weiter unten sind Methoden für die verschiedenen Join-Varianten zu finden, die Zend_Db_Select unterstützt.

  • INNER JOIN mit den Methoden join(tabelle, join, [spalten]) oder joinInner(tabelle, join, [spalten]).

    Dies wird der gebräuchlichste Typ von Join sein. Zeilen jeder Tabelle werden mit Hilfe der angegebenen Join-Bedingung verglichen. Der Ergebnissatz enthält nur die Zeilen, die der Join Bedingungen entsprechen. Der Ergebnissatz kann leer sein, wenn keine Zeile die Bedingung erfüllt.

    Alle RDBMS-Marken unterstützen diese Variante.

  • LEFT JOIN mit der Methode joinLeft(tabelle, bedingung, [spalten]).

    Alle Zeilen der links vom Operanden stehenden Tabelle sind enthalten, passende Zeilen der rechts stehenden Tabelle sind ebenfalls enthalten. Die Spalten der rechts stehenden Tabelle werden mit NULL aufgefüllt, wenn keine zu der linken Tabelle passenden Zeilen existieren.

    Alle RDBMS-Marken unterstützen diese Variante.

  • RIGHT JOIN mit der Methode joinRight(tabelle, bedingung, [spalten]).

    Right Outer Join ist das Gegenstück zu Left Outer Join. Alle Zeilen der rechts vom Operanden stehenden Tabelle sind enthalten, passende Zeilen der links stehenden Tabelle sind ebenfalls enthalten. Die Spalten der links stehenden Tabelle werden mit NULL aufgefüllt, wenn keine zu der rechten Tabelle passenden Zeilen existieren.

    Einige RDBMS-Marken unterstützen diesen Join nicht, aber grundsätzlich kann jeder Right Join durch einen Left Join mit umgekehrter Sortierung der Tabellen dargestellt werden.

  • FULL JOIN mit der Methode joinFull(tabelle, bedingung, [spalten]).

    Ein Full Outer Join ist wie eine Kombination eines Left Outer Join mit einem Right Outer Join. Alle Zeilen beider Tabellen sind enthalten, gepaart miteinander in der gleichen Zeile des Ergebnissatzes wenn die Join-Bedingung erfüllt wird, oder wenn nicht, mit NULL an Stelle der Spalten der anderen Tabelle.

    Einige RDBMS-Marken unterstützen diesen Join nicht.

  • CROSS JOIN mit der Methode joinCross(tabelle, [spalten]).

    Ein Cross Join ist ein Kartesisches Produkt. Jede Zeile der ersten Tabelle wird mit jeder Zeile der zweiten Tabelle verbunden. Daher ist die Anzahl der Zeilen im Ergebnissatz gleich dem Produkt der Zeilenanzahlen der beiden Tabellen. Der Ergebnissatz kann mit Bedingungen einer WHERE-Bedingung gefiltert werden. Ein Cross Join ist ähnlich der alten SQL-89 Join Syntax.

    Die Methode joinCross() hat keinen Parameter für die Join-Bedingung. Einige RDBMS-Marken unterstützen diesen Join nicht.

  • NATURAL JOIN mit der Methode joinNatural(tabelle, [spalten]).

    Ein Natural Join vergleicht alle Spalten die in beiden Tabellen mit gleichem Namen vorkommen. Der Vergleich prüft Gleichheit aller Spalten, ein Vergleich auf Ungleichheit ist kein Natural Join. Von dieser API werden nur Natural Inner Joins unterstützt, auch wenn SQL auch Natural Outer Joins erlaubt.

    Die Methode joinNatural() hat keinen Parameter für die Join-Bedingung.

Zusätzlich zu diesen Join-Methoden können Abfragen durch Verwendung der Methoden JoinUsing vereinfacht werden. Statt dass eine komplette Definition des Joins angegeben wird, kann einfach der Spaltenname übergeben werden, auf welchem gejoint werden soll und das Zend_Db_Select-Objekt vervollständigt die Bedingung alleine.

Example #14 Beispiel für die Methode joinUsing()

  1. // Erzeugt diese Abfrage
  2. //   SELECT *
  3. //   FROM "table1"
  4. //   JOIN "table2"
  5. //   ON "table1".column1 = "table2".column1
  6. //   WHERE column2 = 'foo'
  7.  
  8. $select = $db->select()
  9.              ->from('table1')
  10.              ->joinUsing('table2', 'column1')
  11.              ->where('column2 = ?', 'foo');

Jede der anwendbaren Join-Methoden in der Komponente Zend_Db_Select hat eine entsprechende 'using'-Methode.

  • joinUsing(table, join, [columns]) und joinInnerUsing(table, join, [columns])

  • joinLeftUsing(table, join, [columns])

  • joinRightUsing(table, join, [columns])

  • joinFullUsing(table, join, [columns])

Hinzufügen eines WHERE-Abschnitts

Mit der Methode where() können Kriterien angegeben werden, die den Ergebnissatz einschränken. Das erste Argument dieser Methode ist ein SQL-Ausdruck, welche in einer SQL-WHERE-Klausel der Anfrage steht.

Example #15 Beispiel für die Methode where()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT product_id, product_name, price
  3. //   FROM "products"
  4. //   WHERE price > 100.00
  5.  
  6. $select = $db->select()
  7.              ->from('products',
  8.                     array('product_id', 'product_name', 'price'))
  9.              ->where('price > 100.00');

Note: Auf Ausdrücke, welche an die Methoden where() oder orWhere() übergeben werden, wird keine Quotierung angewendet. Werden Spaltennamen verwendet, die quotiert werden müssen, so muss quoteIdentifier() verwendet werden, wenn der String für die Bedingung formuliert wird.

Das zweite Argument der Methode where() ist optional. Es ist ein Wert, der in den Ausdruck eingesetzt wird. Zend_Db_Select quotiert den Wert und ersetzt ihn für ein Fragezeichen ("?") im Ausdruck.

Example #16 Beispiel für einen Parameter in der Methode where()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT product_id, product_name, price
  3. //   FROM "products"
  4. //   WHERE (price > 100.00)
  5.  
  6. $minimumPrice = 100;
  7.  
  8. $select = $db->select()
  9.              ->from('products',
  10.                     array('product_id', 'product_name', 'price'))
  11.              ->where('price > ?', $minimumPrice);

Man kann als zweiten Parameter ein Array an die Methode where() übergeben, wenn der SQL-Operator IN verwendet wird.

Example #17 Beispiel mit Array als Parameters in der Methode where()

  1. // Diese Abrage wird gebaut:
  2. //   SELECT product_id, product_name, price
  3. //   FROM "products"
  4. //   WHERE (product_id IN (1, 2, 3))
  5.  
  6. $productIds = array(1, 2, 3);
  7.  
  8. $select = $db->select()
  9.              ->from('products',
  10.                     array('product_id', 'product_name', 'price'))
  11.              ->where('product_id IN (?)', $productIds);

Die Methode where() kann mehrere Male in demselben Zend_Db_Select-Objekt aufgerufen werden. Die daraus folgende Anfrage kombiniert die unterschiedlichen Ausdrücke unter Benutzung von AND dazwischen.

Example #18 Beispiel für Mehrfachaufruf der Methode where()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT product_id, product_name, price
  3. //   FROM "products"
  4. //   WHERE (price > 100.00)
  5. //     AND (price < 500.00)
  6.  
  7. $minimumPrice = 100;
  8. $maximumPrice = 500;
  9.  
  10. $select = $db->select()
  11.             ->from('products',
  12.                    array('product_id', 'product_name', 'price'))
  13.             ->where('price > ?', $minimumPrice)
  14.             ->where('price < ?', $maximumPrice);

Wenn mehrere Ausdrücke mit OR verknüpft werden sollen, kann die Methode orWhere() verwendet werden. Sie wird genauso benutzt wie die Methode where(), außer dass dem angegebenen Ausdruck ein OR vorangestellt wird, anstelle eines AND.

Example #19 Beispiel für die Methode orWhere()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT product_id, product_name, price
  3. //   FROM "products"
  4. //   WHERE (price < 100.00)
  5. //     OR (price > 500.00)
  6.  
  7. $minimumPrice = 100;
  8. $maximumPrice = 500;
  9.  
  10. $select = $db->select()
  11.              ->from('products',
  12.                     array('product_id', 'product_name', 'price'))
  13.              ->where('price < ?', $minimumPrice)
  14.              ->orWhere('price > ?', $maximumPrice);

Zend_Db_Select klammert Ausdrücke automatisch mit runden Klammern ein, wenn sie mit einer der Methoden where() oder orWhere() erzeugt wurden. Dies hilft sicherzustellen, dass das Voranstellen von Boolschen Operatoren keine unerwarteten Ergebnisse nach sich zieht.

Example #20 Beispiel für das Einklammern von Boolschen Ausdrücken

  1. // Erzeugt diese Anfrage:
  2. //   SELECT product_id, product_name, price
  3. //   FROM "products"
  4. //   WHERE (price < 100.00 OR price > 500.00)
  5. //     AND (product_name = 'Apple')
  6.  
  7. $minimumPrice = 100;
  8. $maximumPrice = 500;
  9. $prod = 'Apple';
  10.  
  11. $select = $db->select()
  12.              ->from('products',
  13.                     array('product_id', 'product_name', 'price'))
  14.              ->where("price < $minimumPrice OR price > $maximumPrice")
  15.              ->where('product_name = ?', $prod);

Im oben stehenden Beispiel wären die Ergebnisse ohne die Klammern ziemlich anders, weil AND eine höhere Priorität als OR hat. Zend_Db_Select erzeugt runde Klammern, wodurch jeder Ausdruck von aufeinander folgenden Aufrufen der Methode where() fester binden als das AND, welches die Ausdrücke kombiniert.

Hinzufügen eines GROUP BY-Abschnitts

In SQL ermöglicht der GROUP BY-Abschnitt die Zeilenzahl des Ergebnissatzes auf eine Zeile pro eindeutigem Wert der Spalte(n) einzuschränken, welche im GROUP BY-Abschnitt benannt sind.

In Zend_Db_Select können diese Spalte(n) mit der Methode group() angegeben werden. Das Argument der Methode ist ein Spaltenname oder ein Array von Spaltennamen, welche im GROUP BY-Abschnitt stehen sollen.

Example #21 Beispiel für die Methode group()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT p."product_id", COUNT(*) AS line_items_per_product
  3. //   FROM "products" AS p JOIN "line_items" AS l
  4. //     ON p.product_id = l.product_id
  5. //   GROUP BY p.product_id
  6.  
  7. $select = $db->select()
  8.              ->from(array('p' => 'products'),
  9.                     array('product_id'))
  10.              ->join(array('l' => 'line_items'),
  11.                     'p.product_id = l.product_id',
  12.                     array('line_items_per_product' => 'COUNT(*)'))
  13.              ->group('p.product_id');

Wie in dem Array von Spaltennamen der Methode from(), so können auch hier Beziehungsnamen in den Strings der Spaltennamen verwendet werden, und der Spaltenname wird als Bezeichner quotiert, wenn er nicht in runden Klammern steht oder ein Objekt des Typs Zend_Db_Expr ist.

Hinzufügen eines HAVING-Abschnittes

In SQL fügt der HAVING-Abschnitt eine Beschränkungsbedingung für Gruppen von Zeilen ein. Dies ist ähnlich der Einschränkungsbedingungen auf Zeilen, des WHERE-Abschnittes. Die beiden Abschnitte unterscheiden sich jedoch, denn die WHERE Bedingungen werden angewendet, bevor Gruppen definiert wurden. Im Gegensatz werden HAVING-Bedingungen erst angewendet, nachdem Gruppen definiert wurden.

In Zend_Db_Select können Bedingungen für die Einschränkung von Gruppen mit der Methode having() angegeben werden. Die Nutzung ist ähnlich wie die der Methode where(). Das erste Argument ist ein String, welcher einen SQL-Ausdruck enthält. Das zweite Argument ist optional und wird verwendet, um einen Platzhalter im SQL-Ausdruck zu ersetzen. Ausdrücke, die durch mehrfaches Aufrufen der Methode having() erzeugt wurden, werden mit dem Boolschen Operator AND verknüpft, oder mit dem Operator OR, wenn die Methode orHaving() verwendet wird.

Example #22 Beispiel für die Methode having()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT p."product_id", COUNT(*) AS line_items_per_product
  3. //   FROM "products" AS p JOIN "line_items" AS l
  4. //     ON p.product_id = l.product_id
  5. //   GROUP BY p.product_id
  6. //   HAVING line_items_per_product > 10
  7.  
  8. $select = $db->select()
  9.              ->from(array('p' => 'products'),
  10.                     array('product_id'))
  11.              ->join(array('l' => 'line_items'),
  12.                     'p.product_id = l.product_id',
  13.                     array('line_items_per_product' => 'COUNT(*)'))
  14.              ->group('p.product_id')
  15.              ->having('line_items_per_product > 10');

Note: Es wird keine Quotierung auf Ausdrücke angewendet, welche an die Methoden having() oder orHaving() übergeben werden. Werden Spaltennamen verwendet, die quotiert werden müssen, so muss quoteIdentifier() verwendet werden, wenn der String für die Bedingung formuliert wird.

Hinzufügen eines ORDER BY Abschnitts

In SQL gibt der ORDER BY Abschnitt eine oder mehrere Spalten oder Ausdrücke an, wonach ein Ergebnissatz sortiert wird. Wenn mehrere Spalten angegeben sind, werden die sekundären Spalten verwendet um "ties" aufzulösen; die Sortierung wird von sekundären Spalten bestimmt, wenn vorhergehende Spalten identische Werte enthalten. Die Standardsortierung ist vom kleinsten zum größten Wert. Dieses Verhalten kann umgekehrt werden, wenn das Schlüsselwort DESC nach der Spalte angegeben wird.

In Zend_Db_Select kann die Methode order() verwendet werden um Spalten oder Arrays von Spalten anzugeben, nach denen sortiert werden soll. Jedes Element des Arrays ist ein String, welcher die Spalte benennt. Optional kann auf den Namen eines der Schlüsselwörter ASC DESC getrennt durch ein Leerzeichen folgen.

Wie in den Methoden from() und group() werden Spalten als Bezeichner quotiert, wenn sie nicht von runden Klammern eingeschlossen oder vom Objekttyp Zend_Db_Expr sind.

Example #23 Beispiel für die Methode order()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT p."product_id", COUNT(*) AS line_items_per_product
  3. //   FROM "products" AS p JOIN "line_items" AS l
  4. //     ON p.product_id = l.product_id
  5. //   GROUP BY p.product_id
  6. //   ORDER BY "line_items_per_product" DESC, "product_id"
  7.  
  8. $select = $db->select()
  9.              ->from(array('p' => 'products'),
  10.                     array('product_id'))
  11.              ->join(array('l' => 'line_items'),
  12.                     'p.product_id = l.product_id',
  13.                     array('line_items_per_product' => 'COUNT(*)'))
  14.              ->group('p.product_id')
  15.              ->order(array('line_items_per_product DESC',
  16.                            'product_id'));

Hinzufügen eines LIMIT-Abschnitts

Einige RDBMS-Marken erweitern SQL mit einem Anfrageabschnitt, bekannt als LIMIT-Abschnitt. Dieser Abschnitt begrenzt die Anzahl der Zeilen in einem Ergebnissatz auf die angegebene Höchstanzahl. Es kann ebenfalls angegeben werden, dass eine Anzahl von Zeilen ausgelassen werden soll. Dieses Feature erlaubt es, eine Untermenge des Ergebnissatzes zu holen, zum Beispiel wenn Anfrageergebnisse auf einander folgenden Seiten angezeigt werden sollen.

In Zend_Db_Select kann die Methode limit() verwendet werden, um die Anzahl von Zeilen und die Anzahl der auszulassenden Spalten anzugeben. Das erste Argument dieser Methode ist die gewünschte Anzahl an Zeilen. Das zweite Argument gibt die Anzahl der auszulassenden Zeilen an.

Example #24 Beispiel für die Methode limit()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT p."product_id", p."product_name"
  3. //   FROM "products" AS p
  4. //   LIMIT 10, 20
  5. // Identisch zu:
  6. //   SELECT p."product_id", p."product_name"
  7. //   FROM "products" AS p
  8. //   LIMIT 20 OFFSET 10
  9.  
  10. $select = $db->select()
  11.              ->from(array('p' => 'products'),
  12.                     array('product_id', 'product_name'))
  13.              ->limit(20, 10);

Note: Die LIMIT-Syntax wird nicht von allen RDBMS-Marken unterstützt. Einige RDBMS benötigen eine unterschiedliche Syntax für eine ähnliche Funktionalität. Jede Zend_Db_Adapter_Abstract-Klasse enthält eine Methode um die für das RDBMS passende SQL-Syntax zu erzeugen.

Die Methode limitPage() kann als alternativer Weg verwendet werden, um Zeilenanzahl und Offset zu anzugeben. Diese Methode erlaubt es, den Ergebnissatz auf ein Subset aus einer Serie von Subsets mit Reihen einer fixen Länge aus dem Gesamtergebnis zu begrenzen. In anderen Worten gibt man die Länge einer Seite ("page") und die Nummer der Seite an, die als Ergebnis von der Abfrage zurückgegeben werden sollen. Die Seitennummer ist das erste Argument der Methode limitPage(), die Seitenlänge ist das zweite Argument. Beide Argumente werden benötigt; sie haben keinen Standardwert.

Example #25 Beispiel der Methode limitPage()

  1. // Erstelle diese Abfrage:
  2. //   SELECT p."product_id", p."product_name"
  3. //   FROM "products" AS p
  4. //   LIMIT 10, 20
  5.  
  6. $select = $db->select()
  7.              ->from(array('p' => 'products'),
  8.                     array('product_id', 'product_name'))
  9.              ->limitPage(2, 10);

Hinzufügen des Anfragewandlers DISTINCT

Die Methode distinct() ermöglicht es, das Schlüsselwort DISTINCT in die SQL-Syntax einzufügen.

Example #26 Beispiel für die Methode distinct()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT DISTINCT p."product_name"
  3. //   FROM "products" AS p
  4.  
  5. $select = $db->select()
  6.              ->distinct()
  7.              ->from(array('p' => 'products'), 'product_name');

Hinzufügen des Anfragewandlers FOR UPDATE

Die Methode forUpdate() ermöglicht es, die Schlüsselworte FOR UPDATE in die SQL-Syntax einzufügen.

Example #27 Beispiel der Methode forUpdate()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT FOR UPDATE p.*
  3. //   FROM "products" AS p
  4.  
  5. $select = $db->select()
  6.              ->forUpdate()
  7.              ->from(array('p' => 'products'));

Eine UNION-Abfrage erstellen

Man kann Union-Abfragen mit Zend_Db_Select erstellen, indem ein Array von Zend_Db_Select oder SQL Query Strings an die Methode union() übergeben wird. Als zweiter Parameter können die Konstanten Zend_Db_Select::SQL_UNION oder Zend_Db_Select::SQL_UNION_ALL übergeben werden, um den Typ der Union zu anzugeben, den man ausführen will.

Example #28 Beispiel der Methode union()

  1. $sql1 = $db->select();
  2. $sql2 = "SELECT ...";
  3.  
  4. $select = $db->select()
  5.     ->union(array($sql1, $sql2))
  6.     ->order("id");

Ausführen von SELECT-Anfragen

Dieser Abschnitt beschreibt, wie Anfragen ausgeführt werden, die durch ein Zend_Db_Select-Objekt repräsentiert werden.

Ausführen von Select-Anfragen aus dem Db-Adapter

Die Anfrage, die durch das Zend_Db_Select-Objekt repräsentiert wird, kann ausgeführt werden, indem sie als erstes Argument an die Methode query() des Zend_Db_Adapter_Abstract-Objekts übergeben wird. Dabei wird das Zend_Db_Select anstelle eines Strings verwendet.

Die Methode query() gibt ein Objekt vom Typ Zend_Db_Statement oder PDOStatement zurück, je nachdem welcher Adaptertyp verwendet wird.

Example #29 Beispiel für die Nutzung der Methode query() des Db-Adapters

  1. $select = $db->select()
  2.              ->from('products');
  3.  
  4. $stmt = $db->query($select);
  5. $result = $stmt->fetchAll();

Ausführen von Select-Anfragen mit dem Objekt

Als Alternative zur Nutzung der Methode query() des Adapterobjekts kann auch die Methode query() des Objekts Zend_Db_Select verwendet werden. Beide Methoden geben ein Objekt vom Typ Zend_Db_Statement oder PDOStatement zurück, je nachdem welcher Adaptertyp verwendet wird.

Example #30 Beispiel für die Nutzung der Methode query() des Select-Objekts

  1. $select = $db->select()
  2.              ->from('products');
  3.  
  4. $stmt = $select->query();
  5. $result = $stmt->fetchAll();

Konvertieren eines Select-Objekts in einen SQL-String

Wenn Zugriff auf die String-Repräsentation der SQL-Anfrage benötigt wird, welche dem Objekt Zend_Db_Select entspricht, kann die Methode __toString() verwendet werden.

Example #31 Beispiel für die Methode __toString()

  1. $select = $db->select()
  2.              ->from('products');
  3.  
  4. $sql = $select->__toString();
  5. echo "$sql\n";
  6.  
  7. // Ausgabe ist dieser String:
  8. //   SELECT * FROM "products"

Andere Methoden

Dieser Abschnitt beschreibt andere Methoden der Zend_Db_Select Klasse, welche bisher nicht beschrieben wurden: getPart() und reset().

Abfragen von Teilen des Select-Objekts

Die Methode getPart() gibt eine Repräsentation eines Teils der SQL-Anfrage zurück. Zum Beispiel kann diese Methode verwendet werden um ein Array von Ausdrücke des WHERE-Abschnitts, ein Array von Spalten (oder Spaltenausdrücke) von SELECT oder die Werte der Spaltenzahl und Auslassungen des LIMIT-Abschnitts zu erhalten.

Die Rückgabe ist kein String, der ein Fragment der SQL-Syntax enthält. Der Rückgabewert ist eine interne Repräsentation, was typischerweise eine Arraystruktur ist, welche Werte und Ausdrücke enthält. Jeder Teil der Anfrage hat eine unterschiedliche Struktur.

Das einzige Argument der Methode getPart() ist ein String, der den zurückzugebenden Teil der Anfrage bezeichnet. Zum Beispiel bezeichnet der String 'from' den Teil des Select-Objekts, welcher Informationen über den FROM-Abschnitt, einschließlich verbundener Tabellen enthält.

Die Klasse Zend_Db_Select definiert Konstanten, die für Teile der SQL-Anfrage verwendet werden können. Es können die Konstantendefinitionen oder die literalen Strings verwendet werden.

Konstanten, die von getPart() und reset() verwendet werden
Konstante String Wert
Zend_Db_Select::DISTINCT 'distinct'
Zend_Db_Select::FOR_UPDATE 'forupdate'
Zend_Db_Select::COLUMNS 'columns'
Zend_Db_Select::FROM 'from'
Zend_Db_Select::WHERE 'where'
Zend_Db_Select::GROUP 'group'
Zend_Db_Select::HAVING 'having'
Zend_Db_Select::ORDER 'order'
Zend_Db_Select::LIMIT_COUNT 'limitcount'
Zend_Db_Select::LIMIT_OFFSET 'limitoffset'

Example #32 Beispiel der Methode getPart()

  1. $select = $db->select()
  2.              ->from('products')
  3.              ->order('product_id');
  4.  
  5. // Ein literaler String kann verwendet werden, um den Abschnitt zu definieren
  6. $orderData = $select->getPart( 'order' );
  7.  
  8. // Eine Konstante kann verwendet werden, um denselben Abschnitt zu definieren
  9. $orderData = $select->getPart( Zend_Db_Select::ORDER );
  10.  
  11. // Der zurückgegebene Wert kann eine Arraystruktur sein, kein String.
  12. // Jeder Abschnitt hat eine unterschiedliche Struktur.
  13. print_r( $orderData );

Zurücksetzen von Teilen des Select-Objekts

Die Methode reset() ermöglicht es, einen angegebenen Teil der SQL-Anfrage zu löschen oder, wenn der Parameter ausgelassen ist, alle Teile der SQL-Anfrage zu löschen.

Das einzige Argument ist optional. Es kann der Teil der Anfrage angegeben werden, der gelöscht werden soll, unter Nutzung des gleichen Strings wie er als Argument der Methode getPart() verwendet wird. Der angegebene Teil wird auf einen Standardwert zurück gesetzt.

Wenn der Parameter ausgelassen wird, setzt reset() alle geänderten Teile auf einen Standardwert zurück. Dadurch ist das Zend_Db_Select-Objekt gleichwertig mit einem neuen Objekt, wie wenn es gerade instanziiert wurde.

Example #33 Beispiel der Methode reset()

  1. // Erzeugt diese Anfrage:
  2. //   SELECT p.*
  3. //   FROM "products" AS p
  4. //   ORDER BY "product_name"
  5.  
  6. $select = $db->select()
  7.              ->from(array('p' => 'products')
  8.              ->order('product_name');
  9.  
  10. // Geänderte Anforderungen, stattdessen sortiert nach einer anderen Spalte:
  11. //   SELECT p.*
  12. //   FROM "products" AS p
  13. //   ORDER BY "product_id"
  14.  
  15. // Lösche einen Abschnitt, damit er neu defniert werden kann
  16. $select->reset( Zend_Db_Select::ORDER );
  17.  
  18. // und definiere eine andere Spalte
  19. $select->order('product_id');
  20.  
  21. // Lösche alle Abschnitte von der Abfrage
  22. $select->reset();

Copyright

© 2006-2019 by Zend, a Rogue Wave Company. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts