Zend_Db_SelectIntroductionL'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 :
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 SelectVous 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()
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
Construction de requêtes SelectEn 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
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
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 FROMIndiquez 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()
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
Certaines marques de SGBDR supportent un spécificateur de schéma principal
pour une table. Vous pouvez spécifiez un nom de table comme
" Example #7 Exemple d'utilisation d'un nom de schéma
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 " 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
" Example #8 Exemples de spécification de colonnes
Ajouter une expression de colonneLes 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.
Example #9 Exemples d'utilisation de colonnes contenant des expressions
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 Ajouter des colonnes à une table FROM ou JOIN existanteIl 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()
Ajouter une autre table à la requête avec JOINBeaucoup 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()
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.
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 " 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
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.
En plus de ces méthodes join, vous pouvez simplifier vos requêtes en utilisant
les méthodes de type Example #14 Exemple avec la méthode joinUsing()
Chacune des méthodes join applicables du composant Zend_Db_Select possède une méthode correspondante "using".
Ajouter une clause WHEREVous 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()
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 (" Example #16 Exemple d'un paramètre dans la méthode where()
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() 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()
Si vous devez combiner ensemble des termes en utilisant Example #19 Exemple d'utilisation de la méthode orWhere()
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
Dans l'exemple ci-dessus, le résultat serait tout à fait différent sans
parenthèses, car AND a une plus grande priorité que Ajouter une clause GROUP BY
Dans la syntaxe SQL, la clause
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 Example #21 Exemple d'utilisation de la méthode group()
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 HAVINGDans 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 Example #22 Exemple d'utilisation de la méthode having()
Ajouter une clause ORDER BY
Dans la syntaxe SQL, la clause 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()
Ajouter une clause LIMITCertaines 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()
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. Ajouter le modificateur de requête DISTINCTLa 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()
Ajouter le modificateur de requête FOR UPDATE
La méthode forUpdate() vous permet d'ajouter le modificateur
Example #27 Exemple d'utilisation de la méthode forUpdate()
Construire une requête UNIONVous 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()
Exécuter des requêtes SelectCette 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 DbVous 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 Example #29 Exemple d'utilisation de la méthode query() de l'adaptateur Db
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 Example #30 Exemple d'utilisation de la méthode query() de l'objet Select
Convertir un objet Select en une chaîne SQLSi 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()
Autres méthodesCette 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 SelectLa 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 " 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.
Example #32 Exemple d'utilisation de la méthode getPart()
Effacer des parties de l'objet SelectLa 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()
|