Zend_Db_Profiler

Zend_Db_Select

Introduction

L'objet Zend_Db_Select représente une instruction de requête SQL de type SELECT. La classe a des méthodes pour ajouter différentes parties à la requête. Vous pouvez indiquer quelques parties de la requête en utilisant des structures de données et des méthodes de PHP, et la classe forme la syntaxe correcte de SQL pour vous. Après avoir construit une requête, vous pouvez l'exécuter comme si vous l'aviez écrite comme une chaîne de caractères.

Les possibilités offertes par Zend_Db_Select inclut :

  • des méthodes orientées objet pour spécifier des requêtes SQL morceau par morceau ;

  • l'abstraction de certaines parties de la requête SQL indépendamment de la base de données ;

  • l'échappement automatique des identificateurs de méta-données dans la plupart des cas, pour supporter les identificateurs contenant les mots réservés SQL et les caractères spéciaux ;

  • l'échappement des identificateurs et des valeurs, afin de réduire les risques d'attaques par injection SQL.

L'utilisation de Zend_Db_Select n'est pas obligatoire. Pour de très simple requêtes SELECT , il est d'habitude plus simple de spécifier la requête SQL entière comme une chaîne et l'exécuter en utilisant des méthodes de l'adaptateur comme query() ou fetchAll(). L'utilisation de Zend_Db_Select est utile si vous devez assembler une requête SELECT par procédure, ou basé sur une logique conditionnelle dans votre application.

Créer un objet Select

Vous pouvez créer une instance d'un objet Zend_Db_Select en utilisant la méthode select() de l'objet Zend_Db_Adapter_Abstract.

Example #1 Exemple d'utilisation de la méthode select()

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

Une autre manière de créer un objet Zend_Db_Select est avec son constructeur, en indiquant l'adaptateur de base de données comme argument.

Example #2 Exemple de création d'un nouvel objet Select

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

Construction de requêtes Select

En construisant la requête, vous pouvez ajouter des clauses à la requête une par une. Il y a une méthode séparée pour ajouter chaque clause à l'objet Zend_Db_Select.

Example #3 Exemple d'utilisation des méthodes d'ajout de clauses

  1. // Créer un objet Zend_Db_Select
  2. $select = $db->select();
  3.  
  4. // Ajouter une clause FROM
  5. $select->from( ...spécifiez une table et des colonnes... )
  6.  
  7. // Ajouter une clause WHERE
  8. $select->where( ...spécifiez des critères de recherche... )
  9.  
  10. // Ajouter une clause ORDER BY
  11. $select->order( ...spécifiez des critères de tri... );

Vous pouvez également employer la plupart des méthodes de l'objet Zend_Db_Select avec une interface fluide et simple. Une » interface fluide signifie que chaque méthode renvoie une référence à l'objet qui a été appelé, ainsi vous pouvez immédiatement appeler une autre méthode.

Example #4 Exemple d'utilisation de l'interface fluide

  1. $select = $db->select()
  2.              ->from( ...spécifiez une table et des colonnes... )
  3.              ->where( ...spécifiez des critères de recherche... )
  4.              ->order( ...spécifiez des critères de tri... );

Les exemples de cette section montrent l'utilisation de l'interface fluide, mais vous pouvez employer une interface non-fluide dans tous les cas. Il est souvent nécessaire d'employer l'interface non-fluide, par exemple, si votre application doit exécuter de la logique avant d'ajouter une clause à une requête.

Ajouter une clause FROM

Indiquez la table pour la requête en utilisant la méthode from(). Vous pouvez indiquer le nom de table comme une chaîne de caractères. Zend_Db_Select applique l'échappement des identificateurs autour du nom de table, ainsi vous pouvez employer les caractères spéciaux.

Example #5 Exemple d'utilisation de la méthode from()

  1. // Construire cette requête :
  2. //   SELECT *
  3. //   FROM "produits"
  4.  
  5. $select = $db->select()
  6.              ->from( 'produits' );

Vous pouvez également indiquer le nom de corrélation (parfois appelé "l'alias de table") pour une table. Au lieu d'une chaîne de caractère simple, employez un tableau associatif faisant correspondre le nom de corrélation au nom de table. Dans d'autres clauses de la requête SQL, employez ce nom de corrélation. Si votre requête réalise des jointures sur plus d'une table, Zend_Db_Select produit des noms uniques de corrélation basés sur les noms de table, pour chaque table pour lesquelles vous n'indiquez pas le nom de corrélation.

Example #6 Exemple d'utilisation d'un alias de nom de table

  1. // Construire cette requête :
  2. //   SELECT p.*
  3. //   FROM "produits" AS p
  4.  
  5. $select = $db->select()
  6.              ->from( array('p' => 'produits') );

Certaines marques de SGBDR supportent un spécificateur de schéma principal pour une table. Vous pouvez spécifiez un nom de table comme "nomDuSchema.nomDeTable", où Zend_Db_Select échappera chaque partie individuellement, ou vous pouvez spécifier le nom du schéma séparément. Un nom de schéma spécifié dans le nom de table sera prioritaire sur un schéma fourni séparément dans les cas où les deux seraient fournis.

Example #7 Exemple d'utilisation d'un nom de schéma

  1. // Construire cette requête :
  2. //   SELECT *
  3. //   FROM "monschema"."produits"
  4.  
  5. $select = $db->select()
  6.              ->from( 'monschema.produits' );
  7.  
  8. // ou
  9.  
  10. $select = $db->select()
  11.              ->from('produits', '*', 'monschema');

Ajouter des colonnes

Dans le deuxième argument de la méthode from(), vous pouvez indiquer les colonnes à choisir parmi les tables respectives. Si vous n'indiquez aucune colonne, la valeur par défaut est "*", la caractère de remplacement SQL pour "toutes les colonnes".

Vous pouvez énumérer les colonnes dans un tableau simple de chaîne de caractère, ou en tant que tableau associatif faisant correspondre l'alias de la colonne au nom de la colonne. Si vous avez seulement une colonne à requêter, et vous n'avez pas besoin d'indiquer un alias de colonne, vous pouvez l'énumérer comme une chaîne simple au lieu d'un tableau.

Si vous passez un tableau comme argument pour les colonnes, aucune colonne pour la table correspondante ne sera inclus dans le jeu de résultat. Voir un exemple de code sous la section concernant la méthode join().

Vous pouvez indiquer le nom de colonne en tant que "aliasDeTable.nomDeColonne". Zend_Db_Select échappera chaque partie individuellement. Si vous n'indiquez pas un nom d'alias pour une colonne, elle emploie le nom de corrélation de la table nommée dans la méthode courante from().

Example #8 Exemples de spécification de colonnes

  1. // Construire cette requête :
  2. //   SELECT p."produit_id", p."produit_nom"
  3. //   FROM "produits" AS p
  4.  
  5. $select = $db->select()
  6.              ->from(array('p' => 'produits'),
  7.                     array('produit_id', 'produit_nom'));
  8.  
  9. // Construire la même requête, en spécifiant l'alias de table :
  10. //   SELECT p."produit_id", p."produit_nom"
  11. //   FROM "produits" AS p
  12.  
  13. $select = $db->select()
  14.              ->from(array('p' => 'produits'),
  15.                     array('p.produit_id', 'p.produit_nom'));
  16.  
  17. // Construire cette requête avec un alias pour une colonne :
  18. //   SELECT p."produit_id" AS prodno, p."produit_nom"
  19. //   FROM "produits" AS p
  20.  
  21. $select = $db->select()
  22.              ->from(array('p' => 'produits'),
  23.                     array('prodno' => 'produit_id', 'produit_nom'));

Ajouter une expression de colonne

Les colonnes dans les requêtes SQL sont parfois des expressions, pas simplement des noms de colonnes d'une table. Les expressions peuvent avoir des noms d'alias ou peuvent nécessiter d'être échappées. Si la chaîne de caractère désignant votre colonne contient des parenthèses, Zend_Db_Select la reconnaît comme une expression.

Vous pouvez aussi créer un objet de type Zend_Db_Expr explicitement, pour éviter qu'une chaîne soit traitée comme un nom de colonne. Zend_Db_Expr est une classe minimale qui contient une unique chaîne de caractère. Zend_Db_Select reconnaît les objets de type Zend_Db_Expr et les convertit en chaînes de caractères, mais n'applique aucun changement, tel qu'un échappement ou un alias.

Note: Utiliser Zend_Db_Expr pour les noms de colonnes n'est pas nécessaire si votre expression de colonne contient des parenthèses ; Zend_Db_Select reconnaît les parenthèses et traite la chaîne comme une expression en omettant l'échappement et les alias.

Example #9 Exemples d'utilisation de colonnes contenant des expressions

  1. // Construire cette requête :
  2. //   SELECT p."produit_id", LOWER(produit_nom)
  3. //   FROM "produits" AS p
  4. // Une expression avec parenthèses devient implicitement
  5. // un objet Zend_Db_Expr.
  6.  
  7. $select = $db->select()
  8.              ->from(array('p' => 'produits'),
  9.                     array('produit_id', 'LOWER(produit_nom)'));
  10.  
  11. // Construire cette requête :
  12. //   SELECT p."produit_id", (p.prix * 1.08) AS prix_avec_taxe
  13. //   FROM "produits" AS p
  14.  
  15. $select = $db->select()
  16.              ->from(array('p' => 'produits'),
  17.                     array('produit_id',
  18.                           'prix_avec_taxe' => '(p.prix * 1.08)'));
  19.  
  20. // Construire cette requête en utilisant explicitement Zend_Db_Expr :
  21. //   SELECT p."produit_id", p.prix * 1.08 AS prix_avec_taxe
  22. //   FROM "produits" AS p
  23.  
  24. $select = $db->select()
  25.              ->from(array('p' => 'produits'),
  26.                     array('produit_id',
  27.                           'prix_avec_taxe' =>
  28.                                 new Zend_Db_Expr('p.prix * 1.08')));

Dans les cas ci-dessus, Zend_Db_Select ne change pas la chaîne pour appliquer des alias ou échapper les identificateurs. Si ces changements sont nécessaires pour résoudre l'ambiguïté, vous devez faire manuellement les changements dans la chaîne de caractères.

Si vos noms de colonne sont des mots-clés de SQL ou contiennent les caractères spéciaux, vous devriez employer la méthode quoteIdentifier() de l'adaptateur et interpoler le résultat dans la chaîne de caractères. La méthode quoteIdentifier() utilise l'échappement SQL pour délimiter les identificateurs, qui indique clairement que c'est un identificateur pour une table ou une colonne, et non n'importe quelle autre partie de la syntaxe de SQL.

Votre code est plus indépendant du SGBDR si vous utilisez la méthode quoteIdentifier() au lieu d'échapper littéralement dans votre chaîne, car quelques marques de SGBDR utilisent des symboles non standards pour échapper les identificateurs. La méthode quoteIdentifier() est conçue pour utiliser le symbole d'échappement approprié basé sur le type d'adaptateur. La méthode quoteIdentifier() échappe aussi tout caractère d'échappement qui apparaissent dans l'identificateur lui-même.

Example #10 Exemples d'échappement de colonnes dans une expression

  1. // Construire cette requête, en échappant une colonne spéciale
  2. // nommée "from" dans une expression :
  3. //   SELECT p."from" + 10 AS origine
  4. //   FROM "produits" AS p
  5.  
  6. $select = $db->select()
  7.              ->from(array('p' => 'produits'),
  8.                     array('origine' => '(p.'
  9.                                      . $db->quoteIdentifier('from')
  10.                                      . ' + 10)'));

Ajouter des colonnes à une table FROM ou JOIN existante

Il peut y avoir des cas où vous souhaitez ajouter des colonnes à une table FROM ou JOIN existante après que ces méthodes aient été appelées. La méthode columns() vous permet d'ajouter des colonnes spécifiques à n'importe quel moment avant que la requête ne soit exécutée. Vous pouvez fournir les colonnes en tant qu'une chaîne de caractères, une Zend_Db_Expr ou un tableau de ces derniers. Le second argument de cette méthode peut être omis, impliquant que les colonnes sont ajoutées à la table FROM, sinon un alias déjà défini doit être utilisé.

Example #11 Exemples d'ajout de colonnes avec la méthode columns()

  1. // Construire cette requête :
  2. //   SELECT p."produit_id", p."produit_nom"
  3. //   FROM "produits" AS p
  4.  
  5. $select = $db->select()
  6.              ->from(array('p' => 'produits'), 'produit_id')
  7.              ->columns('produit_nom');
  8.  
  9. // Construire la même requête, en spécifiant l'alias :
  10. //   SELECT p."produit_id", p."produit_nom"
  11. //   FROM "produits" AS p
  12.  
  13. $select = $db->select()
  14.              ->from(array('p' => 'produits'), 'p.produit_id')
  15.              ->columns('produit_nom', 'p');
  16.              // Ou alternativement columns('p.produit_nom')

Ajouter une autre table à la requête avec JOIN

Beaucoup de requêtes utiles impliquent l'utilisation de JOIN pour combiner les lignes issues de tables multiples. Vous pouvez ajouter des tables à une requête en utilisant la méthode join(). L'utilisation de cette méthode est similaire à la méthode from(), excepté que vous pouvez aussi spécifier une condition join dans la plupart des cas.

Example #12 Exemple d'utilisation de la méthode join()

  1. // Construire cette requête :
  2. //   SELECT p."produit_id", p."produit_nom", l.*
  3. //   FROM "produits" AS p JOIN "ligne_items" AS l
  4. //     ON p.produit_id = l.produit_id
  5.  
  6. $select = $db->select()
  7.              ->from(array('p' => 'produits'),
  8.                     array('produit_id', 'produit_nom'))
  9.             ->join(array('l' => 'ligne_items'),
  10.                    'p.produit_id = l.produit_id');

Le deuxième argument de join() est une chaîne qui représente la condition join. C'est une expression qui déclare les critères par lesquels les lignes d'une table correspondent aux lignes dans une autre table. Vous pouvez utiliser un nom d'alias dans cette expression.

Note: Aucun échappement n'est appliqué à une expression que vous spécifiez pour une condition join ; si vous avez des noms de colonnes qui nécessitent d'être échappées, vous devez utiliser quoteIdentifier() quand vous préparez la chaîne pour une condition join.

Le troisième argument de join() est un tableau des noms de colonnes, comme c'est utilisé dans la méthode from(). La valeur par défaut est "*", la méthode supporte les alias, les expressions, et les objets Zend_Db_Expr de la même manière que le tableau de noms de colonnes de la méthode from().

Pour ne choisir aucune colonne à partir d'une table, utilisez un tableau vide pour la liste de colonnes. Cette utilisation fonctionnerait aussi avec la méthode from(), mais typiquement vous pouvez avoir besoin de colonnes issues de la table primaire dans vos requêtes, tandis que vous pourriez ne vouloir aucune colonne de la table jointe.

Example #13 Exemple avec aucune colonne spécifiée

  1. // Construire cette requête :
  2. //   SELECT p."produit_id", p."produit_nom"
  3. //   FROM "produits" AS p JOIN "ligne_items" AS l
  4. //     ON p.produit_id = l.produit_id
  5.  
  6. $select = $db->select()
  7.              ->from(array('p' => 'produits'),
  8.                     array('produit_id', 'produit_name'))
  9.              ->join(array('l' => 'ligne_items'),
  10.                     'p.produit_id = l.produit_id',
  11.                     array() ); // liste de colonnes vide

Notez le tableau vide ( array()) dans l'exemple ci-dessus à la place de la liste de colonnes de la table jointe.

Le SQL a plusieurs types de jointures. Voyez la liste ci-dessous des méthodes supportant les différents types de jointures dans Zend_Db_Select.

  • INNER JOIN avec les méthodes join(table, jointure, [colonnes]) ou joinInner(table, jointure, [colonnes]).

    Ceci est le type de jointure le plus commun. Les lignes de chaque table sont comparées en utilisant la condition join spécifiée. Le résultat inclut seulement les lignes qui vérifient la condition join. Le résultat peut être vide si aucune ligne ne satisfait la condition.

    Tous les marques de SGBDR supportent ce type de jointure.

  • LEFT JOIN avec la méthode joinLeft(table, condition, [colonnes]).

    Toutes les lignes issues de la table opérande de gauche sont inclues, les lignes correspondantes de la table de droite sont inclues, et les colonnes de la table opérande de droite sont remplies de NULL si aucune ligne existante ne correspond à la table de gauche.

    Tous les marques de SGBDR supportent ce type de jointure.

  • RIGHT JOIN avec la méthode joinRight(table, condition, [colonnes]).

    La jointure étrangère droite est le complément de la jointure étrangère gauche. Toutes les lignes issues de la table opérande de droite sont inclues, les lignes correspondantes de la table de gauche sont inclues, et les colonnes de la table opérande de gauche sont remplies de NULL si aucune ligne existante ne correspond à la table de droite.

    Certaines marques de SGBDR ne supportent pas ce type de jointure, mais en général toute jointure droite peut être représentée comme une jointure gauche en inversant l'ordre des tables.

  • FULL JOIN avec la méthode joinFull(table, condition, [colonnes]).

    Une jointure étrangère complète est comme la combinaison d'une jointure étrangère gauche et d'une jointure étrangère droite. Toutes les lignes des deux tables sont inclues, appairées ensemble dans la même ligne de résultat si elles satisfont la condition de jointure, et sinon appairées avec des valeurs NULL à la place des colonnes de l'autre table.

    Certaines marques de SGBDR ne supportent pas ce type de jointure.

  • CROSS JOIN avec la méthode joinCross(table, [colonnes]).

    Une jointure croisée est un produit cartésien. Chaque ligne de la première table est assortie avec chaque ligne de la seconde. Ainsi le nombre de lignes du résultat est équivalent au produit du nombre de lignes de chacune des tables. Vous pouvez filtrer le résultat en utilisant une clause WHERE ; dans ce cas une jointure croisée est semblable à l'ancienne syntaxe de jointure SQL-89.

    La méthode joinCross() n'a pas de paramètres pour spécifier la condition de jointure. Certaines marques de SGBDR ne supportent pas ce type de jointure.

  • NATURAL JOIN avec la méthode joinNatural(table, [colonnes]).

    Une jointure naturelle compare chaque(s) colonne(s) qui apparaissent avec le même nom dans les deux tables. La comparaison est l'égalité pour toute(s) la(es) colonne(s) ; la comparaison des colonnes utilisant l'inégalité n'est pas une jointure naturelle. Seules les jointures internes (NdT : INNER) naturelles sont supportées par cette API, même si la syntaxe SQL permet aussi bien des jointures naturelles étrangères (NdT : OUTER).

    La méthode joinNatural() n'a pas de paramètres pour spécifier la condition de jointure.

En plus de ces méthodes join, vous pouvez simplifier vos requêtes en utilisant les méthodes de type join*Using. Au lieu de fournir une condition complète à votre jointure, vous fournissez simplement le nom de la colonne sur laquelle réaliser la jointure et l'objet Zend_Db_Select complète la condition pour vous.

Example #14 Exemple avec la méthode joinUsing()

  1. // Construire cette requête :
  2. //   SELECT *
  3. //   FROM "table1"
  4. //   JOIN "table2"
  5. //   ON "table1".colonne1 = "table2".colonne1
  6. //   WHERE colonne2 = 'foo'
  7.  
  8. $select = $db->select()
  9.              ->from('table1')
  10.              ->joinUsing('table2', 'colonne1')
  11.              ->where('column2 = ?', 'foo');

Chacune des méthodes join applicables du composant Zend_Db_Select possède une méthode correspondante "using".

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

  • joinLeftUsing(table, join, [columns])

  • joinRightUsing(table, join, [columns])

  • joinFullUsing(table, join, [columns])

Ajouter une clause WHERE

Vous pouvez spécifier des critères pour restreindre le nombre de lignes du résultat en utilisant la méthode where(). Le premier argument de cette méthode est une expression SQL, et cette expression est utilisée dans une clause WHERE dans la requête.

Example #15 Exemple d'utilisation de la méthode where()

  1. // Construire cette requête :
  2. //   SELECT produit_id, produit_nom, prix
  3. //   FROM "produits"
  4. //   WHERE prix > 100.00
  5.  
  6. $select = $db->select()
  7.              ->from('produits',
  8.                     array('produit_id', 'produit_nom', 'prix'))
  9.              ->where('prix > 100.00');

Note: Aucun échappement n'est appliqué aux expressions passées aux méthodes where() ou orWhere(). Si vous avez des noms de colonnes qui nécessitent d'être échappés, vous devez utiliser quoteIdentifier() quand vous générez la chaîne pour la condition.

Le second argument de la méthode where() est optionnel. C'est une valeur à substituer dans l'expression. Zend_Db_Select échappe cette valeur et la substitue au caractère point ("?") d'interrogation dans l'expression.

Example #16 Exemple d'un paramètre dans la méthode where()

  1. // Construire cette requête :
  2. //   SELECT produit_id, produit_nom, prix
  3. //   FROM "produits"
  4. //   WHERE (prix > 100.00)
  5.  
  6. $prixminimum = 100;
  7.  
  8. $select = $db->select()
  9.              ->from('produits',
  10.                     array('produit_id', 'produit_nom', 'prix'))
  11.              ->where('prix > ?', $prixminimum);

Vous pouvez fournir un tableau en tant que second paramètre de la méthode where() quand vous utilisez l'opérateur SQL "IN".

Example #17 Exemple d'un paramètre de type tableau pour la méthode where()

  1. // Construire cette requête :
  2. //   SELECT produit_id, produit_nom, prix
  3. //   FROM "produits"
  4. //   WHERE (produit_id IN (1, 2, 3))
  5.  
  6. $productIds = array(1, 2, 3);
  7.  
  8. $select = $db->select()
  9.              ->from('produits',
  10.                     array('produit_id', 'produit_nom', 'prix'))
  11.              ->where('produit_id IN (?)', $productIds);

Vous pouvez appeler la méthode where() plusieurs fois sur la même objet Zend_Db_Select. La requête résultante combine les différents termes ensemble en utilisant AND entre eux.

Example #18 Exemple avec plusieurs appels de where()

  1. // Construire cette requête :
  2. //   SELECT produit_id, produit_nom, prix
  3. //   FROM "produits"
  4. //   WHERE (prix > 100.00)
  5. //     AND (prix < 500.00)
  6.  
  7. $prixminimum = 100;
  8. $prixmaximum = 500;
  9.  
  10. $select = $db->select()
  11.              ->from('produits',
  12.                     array('produit_id', 'produit_nom', 'prix'))
  13.              ->where('prix > ?', $prixminimum)
  14.              ->where('prix < ?', $prixmaximum);

Si vous devez combiner ensemble des termes en utilisant OR, utilisez la méthode orWhere(). Cette méthode est utilisée de la même manière que la méthode where(), excepté que le terme spécifié est précédé par OR, au lieu de AND.

Example #19 Exemple d'utilisation de la méthode orWhere()

  1. // Construire cette requête :
  2. //   SELECT produit_id, produit_nom, prix
  3. //   FROM "produits"
  4. //   WHERE (prix < 100.00)
  5. //     OR (prix > 500.00)
  6.  
  7. $prixminimum = 100;
  8. $prixmaximum = 500;
  9.  
  10. $select = $db->select()
  11.              ->from('produits',
  12.                     array('produit_id', 'produit_nom', 'prix'))
  13.              ->where('prix < ?', $prixminimum)
  14.              ->orWhere('prix > ?', $prixmaximum);

Zend_Db_Select met automatiquement des parenthèses autour de chaque expression spécifiée en utilisant les méthodes where() ou orWhere(). Ceci permet de s'assurer que la priorité de l'opérateur booléen n'entraîne pas de résultats inattendus.

Example #20 Exemple de mise en parenthèse d'expressions booléennes

  1. // Construire cette requête :
  2. //   SELECT produit_id, produit_nom, prix
  3. //   FROM "produits"
  4. //   WHERE (prix < 100.00 OR prix > 500.00)
  5. //     AND (produit_nom = 'Pomme')
  6.  
  7. $prixminimum = 100;
  8. $prixmaximum = 500;
  9. $prod = 'Pomme';
  10.  
  11. $select = $db->select()
  12.              ->from('produits',
  13.                     array('produit_id', 'produit_nom', 'prix'))
  14.              ->where("prix < $prixminimum OR prix > $prixmaximum")
  15.              ->where('produit_nom = ?', $prod);

Dans l'exemple ci-dessus, le résultat serait tout à fait différent sans parenthèses, car AND a une plus grande priorité que OR. Zend_Db_Select applique les parenthèses avec pour effet de relier de manière plus étroite chaque expression dans les appels successifs de where() qu'avec AND qui combine les expressions.

Ajouter une clause GROUP BY

Dans la syntaxe SQL, la clause GROUP BY vous permet de réduire le nombre de lignes du résultat de la requête à une ligne par valeur unique trouvé dans une(des) colonne(s) nommées) dans la clause GROUP BY.

Dans Zend_Db_Select, vous pouvez spécifier la(es) colonne(s) à utiliser pour calculer les groupes de lignes en utilisant la méthode group(). L'argument de cette méthode est une colonne ou un tableau de colonnes à utiliser dans la clause GROUP BY.

Example #21 Exemple d'utilisation de la méthode group()

  1. // Construire cette requête :
  2. //   SELECT p."produit_id", COUNT(*) AS ligne_items_par_produit
  3. //   FROM "produits" AS p JOIN "ligne_items" AS l
  4. //     ON p.produit_id = l.produit_id
  5. //   GROUP BY p.produit_id
  6.  
  7. $select = $db->select()
  8.              ->from(array('p' => 'produits'),
  9.                     array('produit_id'))
  10.              ->join(array('l' => 'ligne_items'),
  11.                     'p.produit_id = l.produit_id',
  12.                     array('ligne_items_par_produit' => 'COUNT(*)'))
  13.             ->group('p.produit_id');

Comme le tableau de colonnes de la méthode from(), vous pouvez utiliser des noms d'alias dans le nom de la colonne, et la colonne est échappée comme un identificateur à moins que la chaîne ne contiennent des parenthèses ou que ce soit un objet de type Zend_Db_Expr.

Ajouter une clause HAVING

Dans la syntaxe SQL, la clause HAVING applique une restriction sur un groupe de lignes. Ceci est similaire à la manière dont la clause WHERE applique une restriction sur des lignes. Mais les deux clauses sont différentes car les conditions WHERE sont appliquées avant que les groupes de lignes ne soient définis, alors que les conditions HAVING sont appliquées après que les groupes aient été définis.

Dans Zend_Db_Select, vous pouvez spécifier des conditions pour restreindre des groupes en utilisant la méthode having(). Son utilisation est similaire à celle de la méthode where(). Le premier argument est une chaîne contenant une expression SQL. Le second argument facultatif est une valeur qui est utilisé pour remplacer le caractère de substitution positionné dans l'expression SQL. Les expressions passées dans de multiples appels de la méthode having() sont combinées en utilisant l'opérateur booléen AND, ou l'opérateur OR si vous utilisez la méthode orHaving().

Example #22 Exemple d'utilisation de la méthode having()

  1. // Construire cette requête :
  2. //   SELECT p."produit_id", COUNT(*) AS ligne_items_par_produit
  3. //   FROM "produits" AS p JOIN "ligne_items" AS l
  4. //     ON p.produit_id = l.produit_id
  5. //   GROUP BY p.produit_id
  6. //   HAVING ligne_items_par_produit > 10
  7.  
  8. $select = $db->select()
  9.              ->from(array('p' => 'produits'),
  10.                     array('produit_id'))
  11.              ->join(array('l' => 'ligne_items'),
  12.                     'p.produit_id = l.produit_id',
  13.                     array('ligne_items_par_produit' => 'COUNT(*)'))
  14.              ->group('p.produit_id')
  15.              ->having('ligne_items_par_produit > 10');

Note: Aucun échappement n'est appliqué aux expressions fournies aux méthodes having() ou orHaving(). Si vous avez des noms de colonnes qui nécessitent d'être échappées, vous devez utiliser quoteIdentifier() quand vous générez la chaîne de cette condition.

Ajouter une clause ORDER BY

Dans la syntaxe SQL, la clause ORDER BY spécifie une ou plusieurs colonnes ou expressions suivant lesquelles le résultat d'une requête doit être trié. Si plusieurs colonnes sont listées, les colonnes secondaires sont utilisées pour résoudre les égalités ; l'ordre du tri est déterminé par les colonnes secondaires si les colonnes précédentes contiennent des valeurs identiques. Le tri par défaut est ascendant (du plus petit vers le plus grand). Vous pouvez aussi appliqué un tri descendant (du plus grand vers le plus petit) pour une colonne en spécifiant le mot-clé DESC après la colonne.

Dans Zend_Db_Select, vous pouvez utiliser la méthode order() pour spécifier une colonne ou un tableau de colonnes par lesquelles vous voulez trier. Chaque élément du tableau est une chaîne nommant une colonne, facultativement suivi les mots-clés ASC ou DESC en séparant avec un espace.

Comme pour les méthodes from() et group(), les noms de colonnes sont échappées comme des identificateurs, à moins qu'elles ne contiennent des parenthèses ou ne soient des objets de type Zend_Db_Expr.

Example #23 Exemple d'utilisation de la méthode order()

  1. // Construire cette requête :
  2. //   SELECT p."produit_id", COUNT(*) AS ligne_items_par_produit
  3. //   FROM "produits" AS p JOIN "ligne_items" AS l
  4. //     ON p.produit_id = l.produit_id
  5. //   GROUP BY p.produit_id
  6. //   ORDER BY "ligne_items_par_produit" DESC, "produit_id"
  7.  
  8. $select = $db->select()
  9.              ->from(array('p' => 'produits'),
  10.                     array('produit_id'))
  11.              ->join(array('l' => 'ligne_items'),
  12.                     'p.produit_id = l.produit_id',
  13.                     array('ligne_items_par_produit' => 'COUNT(*)'))
  14.              ->group('p.produit_id')
  15.              ->order(array('ligne_items_par_produit DESC',
  16.                            'produit_id'));

Ajouter une clause LIMIT

Certaines marques de SGBDR étendent la syntaxe SQL avec une clause LIMIT. Cette clause réduit le nombre de lignes d'un résultat à un nombre maximum que vous spécifiez. Vous pouvez de plus indiquer un nombre de lignes à éviter avant de commencer à produire le résultat. Cette fonctionnalité facilite l'extraction d'un sous-ensemble d'un résultat, par exemple quand vous affichez des résultats avec un défilement de pages.

Dans Zend_Db_Select, vous pouvez utiliser la méthode limit() pour spécifier le nombre de lignes ainsi que le nombre de lignes à omettre. Le premier argument de cette méthode est le nombre de lignes désirées. Le second argument est le nombre de lignes à omettre.

Example #24 Exemple d'utilisation de la méthode limit()

  1. // Construire cette requête :
  2. //   SELECT p."produit_id", p."produit_nom"
  3. //   FROM "produits" AS p
  4. //   LIMIT 10, 20
  5.  
  6. $select = $db->select()
  7.              ->from(array('p' => 'produits'),
  8.                     array('produit_id', 'produit_nom'))
  9.              ->limit(10, 20);

Note: La syntaxe LIMIT n'est pas supporté par toutes les marques de SGBDR. Quelques SGBDR nécessite une syntaxe différente pour supporter une fonctionnalité similaire. Chaque classe Zend_Db_Adapter_Abstract inclue une méthode pour produire le code SQL approprié à ce SGBDR.

Utilisez de manière alternative la méthode limitPage() pour spécifier le nombre de lignes et le décalage. Cette méthode vous permet de limiter le jeu de résultats à une série d'un nombre fixé de résultats issus du jeu total de résultats de la requête. En d'autres termes, vous spécifiez la taille de la "page" de résultats, et le nombre ordinal de la page unique de résultats que vous souhaitez voir retourner par la requête. Le numéro de la page est le premier argument de la méthode limitPage(), et la taille de la page est le second argument. Les deux arguments sont obligatoires ; ils n'ont pas de valeurs par défaut.

Example #25 Exemple d'utilisation de la méthode limitPage()

  1. // Construire cette requête :
  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);

Ajouter le modificateur de requête DISTINCT

La méthode distinct() vous permet d'ajouter le mot-clé DISTINCT à votre requête SQL.

Example #26 Exemple d'utilisation de la méthode distinct()

  1. // Construire cette requête :
  2. //   SELECT DISTINCT p."produit_nom"
  3. //   FROM "produits" AS p
  4.  
  5. $select = $db->select()
  6.              ->distinct()
  7.              ->from(array('p' => 'produits'), 'produit_nom');

Ajouter le modificateur de requête FOR UPDATE

La méthode forUpdate() vous permet d'ajouter le modificateur FOR UPDATE à votre requête SQL.

Example #27 Exemple d'utilisation de la méthode forUpdate()

  1. // Construire cette requête :
  2. //   SELECT FOR UPDATE p.*
  3. //   FROM "produits" AS p
  4.  
  5. $select = $db->select()
  6.              ->forUpdate()
  7.              ->from(array('p' => 'produits'));

Construire une requête UNION

Vous pouvez construire des requêtes de type union avec Zend_Db_Select en fournissant un tableau de Zend_Db_Select ou de chaînes de requêtes SQL à la méthode union(). En second paramètre, vous pouvez fournir les constantes Zend_Db_Select::SQL_UNION ou Zend_Db_Select::SQL_UNION_ALL pour spécifier le type d'union que vous souhaitez réaliser.

Example #28 Exemple avec la méthode union()

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

Exécuter des requêtes Select

Cette section décrit comment exécuter une requête représentée par un objet Zend_Db_Select.

Exécuter des requêtes Select à partir de l'adaptateur Db

Vous pouvez exécuter la requête représentée par l'objet Zend_Db_Select en le passant comme premier argument de la méthode query() d'un objet Zend_Db_Adapter_Abstract. Utilisez les objets Zend_Db_Select plutôt qu'une simple chaîne de requête.

La méthode query() retourne un objet de type Zend_Db_Statement ou PDOStatement, dépendant du type d'adaptateur.

Example #29 Exemple d'utilisation de la méthode query() de l'adaptateur Db

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

Exécuter des requêtes Select à partir de objet Select

Comme alternative à l'emploi de la méthode query()de l'objet adaptateur, vous pouvez utiliser la méthode query() de l'objet Zend_Db_Select. Les deux méthodes retourne un objet de type Zend_Db_Statement ou PDOStatement, dépendant du type d'adaptateur.

Example #30 Exemple d'utilisation de la méthode query() de l'objet Select

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

Convertir un objet Select en une chaîne SQL

Si vous devez accéder à la chaîne représentant la requête SQL correspondant à un objet Zend_Db_Select, utilisez la méthode __toString().

Example #31 Exemple d'utilisation de la méthode __toString()

  1. $select = $db->select()
  2.              ->from('produits');
  3.  
  4. $sql = $select->__toString();
  5. echo "$sql\n";
  6.  
  7. // L'affichage est la chaîne :
  8. //   SELECT * FROM "produits"

Autres méthodes

Cette section décrit les autres méthodes de la classe Zend_Db_Select qui ne sont pas couvertes ci-dessus : getPart() et reset().

Récupérer des parties de l'objet Select

La méthode getPart() retourne une représentation d'une partie de votre requête SQL. Par exemple, vous pouvez utiliser cette méthode pour retourner un tableau d'expressions pour la clause WHERE, ou un tableau de colonnes (ou d'expressions de colonnes) qui sont dans l'élément SELECT, ou les valeurs de nombre et de décalage pour la clause LIMIT.

La valeur retournée n'est pas une chaîne de caractère contenant un fragment de syntaxe SQL. La valeur retournée est une représentation interne, qui est typiquement une structure de type tableau contenant des valeurs et des expressions. Chaque partie de la requête a une structure différente.

L'argument unique de la méthode getPart() est une chaîne qui identifie quelle partie de la requête Select doit être retournée. Par exemple, la chaîne "from" identifie la partie de l'objet Select qui stocke l'information concernant les tables dans la clause FROM, incluant les tables jointes.

La classe Zend_Db_Select définit des constantes que vous pouvez utiliser pour les parties de la requête SQL. Vous pouvez utiliser ces constantes ou des chaînes de caractères littérales.

Constantes utilisées par getPart() et reset()
Constante Chaîne correspondante
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 Exemple d'utilisation de la méthode getPart()

  1. $select = $db->select()
  2.              ->from('produits')
  3.              ->order('produit_id');
  4.  
  5. // Vous pouvez spécifier une chaîne littérale
  6. $orderData = $select->getPart( 'order' );
  7.  
  8. // Vous pouvez utiliser une constante
  9. $orderData = $select->getPart( Zend_Db_Select::ORDER );
  10.  
  11. // La valeur retournée peut être une structure tableau, pas une chaîne.
  12. // Chaque partie a une structure différente
  13. print_r( $orderData );

Effacer des parties de l'objet Select

La méthode reset() vous permet de vider une partie spécifique de la requête SQL, ou toutes les parties si vous omettez l'argument.

L'argument unique est facultatif. Vous pouvez spécifier la partie de la requête à effacer, en utilisant les mêmes chaînes que vous utilisez en tant qu'argument de la méthode getPart(). La partie de la requête que vous spécifiez est initialisée à l'état par défaut.

Si vous omettez le paramètre, reset() initialise toutes les parties de la requête à leurs valeurs par défaut. Ceci rend l'objet Zend_Db_Select équivalent à un nouvel objet, comme si vous l'aviez tout juste instancié.

Example #33 Exemple d'utilisation de la méthode reset()

  1. // Construire cette requête :
  2. //   SELECT p.*
  3. //   FROM "produits" AS p
  4. //   ORDER BY "produit_nom"
  5.  
  6. $select = $db->select()
  7.              ->from(array('p' => 'produits')
  8.              ->order('produit_nom');
  9.  
  10. // Changer la condition d'ordre avec une colonne différente :
  11. //   SELECT p.*
  12. //   FROM "produits" AS p
  13. //   ORDER BY "produit_id"
  14.  
  15. // Vider la partie afin de la redéfinir
  16. $select->reset( Zend_Db_Select::ORDER );
  17.  
  18. // Et spécifier une colonne différente
  19. $select->order('produit_id');
  20.  
  21. // Vider toutes les parties de la requête
  22. $select->reset();

Zend_Db_Profiler