Base de données et requêtes

Si le module que vous souhaitez créer fait appel à  des données stockées dans des tables de la Bdd, vous serez amené, dês le début de sa création, à  mettre en place vos tables et écrire les requêtes nécessaires à  l'extraction, ou l'insertion, de ces données.
Ce document a pour but de vous expliquer les grandes lignes à  suivre, le détail des méthodes utilisables se trouvant dans le mémento du développeur.

1) Les tables

• Nous supposerons que vous êtes familer avec l'organisation des données dans les tables, les différents types de champs, les index, etc.
  Si ce n'est pas le cas, approfondissez la question, car il est primordial de créer correctement les tables avant de coder, toute modification ultérieure risquant de se répercuter sur de nombreuses portions de code.
  
  
• Normalisez vos tables: il existe des rêgles précises relatives à  la répartition des données dans les tables et le contenu des différents champs. Si vous ignorez ce que sont les formes normales d'une base, il existe une littérature abondante sur le net (ou en librairie) sur ces formes normales: mais rassurez-vous, celà  n'a rien de complexe et peut-être vos tables sont déjà  normalisées sans que vous le sachiez!
  
  
• Envisagez la création d'une table 'categories' si votre application s'y prête (c'est souvent le cas): xoops dispose de différentes méthodes de la classe xoopsTree permettant de gérer les catégories et sous-catégories dans lesquelles vous aurez classé vos données.
  
  
• Enfin, je ne saurais que trop vous conseiller de créer une classe dérivée de la classe xoopsObject : vos requêtes seront 'concentrées' dans cette classe, ce qui permet de répercuter les modifications de table beaucoup plus facilement, et vous ne travaillez plus avec des requêtes dans votre code, mais ferez appel aux méthodes getVar, setVar, initVar, etc.
  

2) Conventions

Respectez les conventions d'écriture, votre code n'en sera que plus lisible et compréhensible par vous-même, mais également par vos utilisateurs.
Certaines de ces conventions sont officielles, d'autres sont des conventions d'usage.
- Les instructions sql doivent être écrites en majuscules (SELECT, GROUP BY, etc.)
- Utilisez (de préférence) $sql pour écrire la requête dans une chaine de caractêre.
- Utilisez (de préférence) $result pour le résultat de la requête.
- Utilisez (de préférence) $myrow pour parcourir les lignes du tableau $result.

3) Requêtes

N'utilisez jamais directement les fonctions mysql_ , n'utilisez que les méthodes de l'object xoopsDB : $xoopsDB->prefix(), $xoopsDB->query(), etc.
* Pour vous affranchir des instructions de connection à  la Bdd.
* Pour bénéficier du mode debug sql.
* Pour une éventuelle compatibilité de xoops avec d'autres bases de données.

Ecrivez votre requête dans une chaine de caractêre ($sql) :
$sql = 'SELECT * FROM '.$xoopsDB->prefix('mymodule_table1').' WHERE champ1 = '.$variable.' AND champ2 = '.$variable2';
Cette façon de procéder présente plusieurs avantages:
- une meilleure lisibilité du code
- la possibilité d'afficher votre requête avec un echo $sql pendant la phase de mise au point
- la possibilité de concaténer votre requête suivant le résultat d'un test

Puis exécutez la requête
$result = $xoopsDB->query($sql)

Pendant la phase de développement, mettez un test pour vérifier son exécution
if ( !$result ) { die( 'Erreur sql : '.$sql ); }

L'astuce ci-dessus présente plusieurs avantages si votre requête ne s'exécute pas :
- votre requête s'affichera et vous permettra de voir s'il manque un élément (ex WHERE champ1= AND.)
- vous pourrez faire un copier /coller de cette requête et l'exécuter avec phpmyadmin pour voir le résultat.

Dans votre code définitif, ne laissez pas ce test, mais supprimez le, ou mieux modifiez le pour faire une redirection sur un message d'erreur, par exemple :.

Prévoyez également le cas où votre requête SELECT ne retourne aucun résultat, qui, s'il n'est pas traité, peut aboutir à  une page blanche

4) Requêtes SELECT

Il existe de nombreuses méthodes pour exploiter les résultats.
Vous trouverez différents exemples à  la page xoopsDB du mémento du développeur.
N'oubliez pas que les résultats sont obtenus sous forme d'un tableau qu'il faudra parcourir pour en extraire les résultats. Une bonne compréhension de la notion des tableaux en Php vous est donc recommandée !

5) Requêtes INSERT et UPDATE

Avant d'insérer des données dans une table, et particuliêrement si elles proviennent d'un formulaire, il est impératif de contrôler la validité de ces données.
Exemple pour une donnée numérique: $number = intval($number);
Pour du texte, utilisez les différentes méthodes de la classe MyTextSanitizer.
Enfin, n'oubliez pas que votre texte, pour être inséré, doit être placé entre simples quotes.
Vous pourrez utiliser pour celà  la méthode $xoopsDB->quoteString($mytext)

6) queryF

J'avoue ne pas tout connaitre à  propos des requêtes et de queryF, et ne vous livrerai donc que ce que je sais :
- il arrive que les requêtes INSERT, UPDATE ou DELETE ne s'exécutent pas en utilisant la méthode $xoopsDB->query($sql).
- on peut utiliser dans ce cas la méthode $xoopsDB->queryF($sql), le F signifiant force.
- attention, l'utilisation non contrôlée de cette méthode peut entrainer une faille de sécurité, il est impératif de vérifier les données avant insertion.

7) Déclaration

Si vous utilisez les méthodes de la classe xoopsDB dans une fonction, n'oubliez pas de la déclarer globale:

8) Mise au point

Vous disposez pour la mise au point de vos requêtes de la console de débuggage que vous activez dans
Administration>>Systême>>Préférences>>Paramêtres généraux>>Mode de mise au point>>MySQL/Blocs

Personnellement, je préfêre rester en mode Mise au point Php et insérer des echo $sql.'<br>'; à  la suite des mes requêtes, plutôt que d'avoir cette fenêtre qui surgit à  chaque page ...

Par contre, cette console de débuggage est extrêmement utile pour connaitre toutes les requêtes qui s'exécutent à  l'appel d'une page, vous permettant ainsi, entre autres, de faire la chasse aux requêtes inutiles !