php, base de données et couche d'abstraction 3 (Driver MySQL)

llaumgui — Sat, 05 Feb 2005 00:25:00 +0000

Je viens de porter quelques retouches à mes driver MySQL (Ceux que j'utilise pour PortaLL mon portail perso). J'en profite donc pour vous les présenter. A noter que je n'ai pas encore testé l'abstraction avec un autre SGBD, mais normalement tout devrait aller très bien ;-).

Au programme des fonctionnalités :

Connexion/déconnexion.
Fonctions de base MySQL.
Compteur de requête.
Liste des requêtes effectuées par une page.
Mise en forme des requêtes avant de les afficher pour une lecture et un débogage facilités.

<?

/*-------------------------------------------------------------------------

|   PortaLL 2.1.

========================================

|   Par LLaumgui

|   (c) 2004

========================================

|   Web: http://www.xperience-fr.net

|   eMail: llaumgui_AT_xperience-fr.net

+-------------------------------------------------------------------------- */



/**

* Gestion des relation avec une base de données mySQL.

* @package portall

* @author LLaumgui

* @version $Id

*/



class DataBase {





    var $data = array ("db_host"   => "",

                       "db_login"  => "",

                       "db_pass"   => "",

                       "db_name"   => "",

                       "debug_mod" => "");         // Information présente dans la conf_global.php.

    

    var $query             = "";                   // La requête.

    var $listQuery         = "";                     // La liste des requêtes (débug mod = 2).

    var $connectionServer;                           // Connexion au serveur.

    var $connectionDB;                               // Connexion à la base de donées.

    var $countQuery        = 0;                      // nombre de requêtes MySQL

    var $fetch_row          = array();               // mysql_fetch_row

                           

                    

/**

* Constructeur de la classe

*/

    function DataBase() {

        require ROOT_PATH."conf_global.php";

        

        $this->data['db_host']   = $CONF['DB_HOST'];

        $this->data['db_login']  = $CONF['DB_LOGIN'];

        $this->data['db_pass']   = $CONF['DB_PASSWORD'];

        $this->data['db_name']   = $CONF['DB_NAME'];

        $this->data['debug_mod'] = $CONF['DEBUG'];

    }





//####################################################################################################

//      Fonctions de base du SGBD.

//####################################################################################################

    /**

     * Connexion à la base de données

     * @author LLaumgui

     */

    function connect() {

    

        $this->connectionServer = mysql_connect($this->data['db_host'],

                                                 $this->data['db_login'],

                                                 $this->data['db_pass'])

                                   or die ("PortaLL ERROR: Cannot connect to mySQL server");

        

        $this->connectionDB     = mysql_select_db($this->data['db_name'],

                                                     $this->connectionServer)

                                   or die ("PortaLL ERROR: Cannot connect to database ".$this->data['db_name']."");

    }





    /**

     * Requête simple

     * @author LLaumgui

     * @param (String) La requête à exécuter

     * @return (String) La requête

     */

    function query( $query ) {

    

        $this->query = mysql_query ($query) or die ($this->errorMsg($query));        // Requête mySQL.

        

        // Débugage

        if ($this->data['debug_mod'] > 0 ) { $this->countQuery++; }                                                // +1 requêtes.

        if ($this->data['debug_mod'] > 1 ) { $this->listQuery .= $query.'<br /><hr align="center" />'; }        // Ajoute les requète à la liste.

        

        return $this->query;

    }

    

    

    /**

     * Fonction mysql_fetch_array

     * @author LLaumgui

     * @param (String) La requête à exécuter

     * @return (array) Résultat de la commande mysql_fetch_array

     */

     function fetch_row( $query = "" ) {

    

        if ( empty($query) )

            { $this->fetch_row = mysql_fetch_array ($this->query); }

        else

            { $this->fetch_row = mysql_fetch_array ($query); }

        

        return $this->fetch_row;

    }

    

    

    /**

     * Fonction mysql_num_rows

     * @author LLaumgui

     * @param (String) La requête à exécuter

     * @return (int) Résultat de la commande mysql_num_rows

     */

    function num_rows( $query = "" ) {

    

        if ( empty($query) )

            { $num_rows = mysql_num_rows ($this->query); }

        else

            { $num_rows = mysql_num_rows ($query); }

        

        return $num_rows;

    }

    

    

//####################################################################################################

//      Fonctions évoluées

//####################################################################################################

    /**

     * Compteur de requète (Debug mod > 0)

     * @author LLaumgui

     * @return (int) Nombre de requêtes

     */

    function countQuery() {

    

        return $this->countQuery;

    }

    

    

    /**

     * Liste des requêtes utilisées pour une page (Debug mod > 1)

     * @author LLaumgui

     * @return (String) Liste des requêtes

     */

    function listQuery( $query = "" ) {

    

        $this->listQuery = $this->layout($this->listQuery, $separator = "<br />");

        

        return '<b><u><font size="+1">Debug mySQL :</font></u></b><br /><br />'.$this->listQuery;

    }

    

    

    /**

     * Message d'erreur en cas de problème sur une requète mySQL

     * @author LLaumgui

     * @return (String) Message d'erreur

     */

    function errorMsg( $query = "" ) {

            

        $msg_error = '<font color="#FF0000" size="6"><b>mySQL query error :</b></font><p> </p>';

        

        $msg_error .= '<p><b>mySQL error :</b> '.mysql_error().'</p>';

        

        $msg_error .= '<p><b>mySQL error code :</b> '.mysql_errno().'</p>';

        

        $msg_query = $this->layout($query);

        

        $msg_error .= '<span style="border: 1px solid #000000; width: 500px">'.$msg_query.'</span>';

        

        return errorMsg;

    }

    

    

    /**

     * Mise en forme du code mySQL

     * @author LLaumgui

     * @param (String) Liste des requêtes brute

     * @param (String) Séparateur de requêtes

     * @return (String) La liste des requêtes exécutées mise en forme

     */

    function layout( $text, $separator = "<br />" ) {

        

        if ($separator == '<br />' || $separator == '<br />' ) { $tab = '     '; } else { $tab = ''; }

        

        $text = preg_replace( '#SELECT\s(.+?)\sFROM\s#is' , '<span class="debug_command"><b>SELECT</b></span> \\1'.$separator.'<span class="debug_command"><b>FROM</b></span> ', $text );                        // SELECT xxx FROM

        $text = preg_replace( '#INSERT INTO\s(.+?)\sVALUES\s#is' , '<span class="debug_command"><b>INSERT INTO</b></span> \\1'.$separator.'<span class="debug_command"><b>VALUES</b></span> ', $text );            // INSERT xxx INTO

        $text = preg_replace( '#UPDATE\s(.+?)\sSET\s#is' , '<span class="debug_command"><b>UPDATE</b></span> \\1'.$separator.'<span class="debug_command"><b>SET</b></span> ', $text );            // UPDATE xxx SET

        $text = preg_replace( '#DELETE FROM\s#is' , '<span class="debug_command"><b>DELETE FROM</b></span> ', $text );                                                                                    // DELET FROM xxx

        $text = preg_replace( '#\sLEFT JOIN\s(.+?)\sON\s#is' , $separator.$tab.'<span class="debug_command"><b>LEFT JOIN</b></span> \\1 <span class="debug_command"><b>ON</b></span> ', $text );                    // LEFT JOIN xxx ON

            $text = preg_replace( '#\sWHERE\s#is' , $separator.'<span class="debug_command"><b>WHERE </b></span>', $text );                                                                            // WHERE

            $text = preg_replace( '#\sORDER BY\s#is' , $separator.'<span class="debug_command"><b>ORDER BY</b></span> ', $text );                                                                        // ORDER BY

            $text = preg_replace( '#\sLIMIT\s#is' , $separator.'<span class="debug_command"><b>LIMIT</b></span> ', $text );                                                                            // LIMIT

            $text = preg_replace( '#\sCOUNT\((.+?)\)\sAS\s#is' , ' <b>COUNT(</b>\\1<b>) AS</b> ', $text );

            

        return $text;

    }





    /**

     * Déconnexion de la base de données

     * @author LLaumgui

     */

    function close() {



        mysql_close( $this->connectionServer );

    }

    

    

}    // EOC





?>

Ce qui donne avec le mod débug activé :

Poursuivre l'aventure :

php, base de données et couche d'abstraction 1 (Principe).
php, base de données et couche d'abstraction 2 (Compteur de requêtes).
php, base de données et couche d'abstraction 3 (Driver MySQL).

php, base de données et couche d'abstraction 2 (Compteur de requêtes)

llaumgui — Tue, 18 Jan 2005 19:57:00 +0000

Nous avons Vu précédement le principe des couches d'abstraction dans la gestion des SGBD. Maintenant allons plus loin et réalisons un compteur de requêtes.

Prenons l'exemple d'une base de donées MySQL. Si vous avez bien compris le principe de la couche d'abstraction, vous devez avoir une classe avec une fonction ressemblant à celle si :

class database {



    /* [...]

     * On passe la partie connexion à la base de données et définition des variables de la classe

     *(Notament Countquery qui doit être initialisé à 0).

     * [..]

     */

    function query( $query ) {

    

        // On réalise la requête MySQL

        $this->Query = mysql_query ($query) or die ( $this->error_msg($query) );

        

        // Compteur de requête :

        $this->Countquery++;



        return $this->Query;

    }

Nous avons donc établi un compteur de requête qui s'incrémente à chaque appel de la fonction query(). Nous pouvons aller plus loin est stoker les requêtes dans un tableau afin de les afficher ultérieurement.

Poursuivre l'aventure :

php, base de données et couche d'abstraction 1 (Principe).
php, base de données et couche d'abstraction 2 (Compteur de requêtes).
php, base de données et couche d'abstraction 3 (Driver MySQL).

php, base de données et couche d'abstraction 1 (Principe)

llaumgui — Wed, 12 Jan 2005 14:57:00 +0000

Jusqu'a présent, le système de gestion de base de données (SGBD) par excellence avec php était MySQL. L'arrivé de php5 et sa future démocratisation bouscule cette donne en mettant en avant le SGBD SQLite.

Comment passer le MySQL à SQLite facilement? Juste en modifiant une seule variable? C'est là qu'interviennent les couches d'abstraction.

Qu'est ce qu'un couche d'abstraction?

De même que des drivers différents permettent l'utilisation d'une périphérie hardware à des systèmes différents; une couche d'abstraction permettra au même code php d'attaquer des bases de données différentes.

Comment?

Tout simplement car le code n'attaque pas la base de données mais la couche d'abstraction que nous appellerons drivers.

Ainsi après avoir instancié les drivers adéquates (On peut passer par une variable pour lancer cette instance ce qui permet de changer de drivers en modifiant une seule variable!!!) :

// Récupération du drivers :

require_once ROOT_PATH."kernel/".$CONF['DB_SGBD'].".php";



// Instanciation :

$DB             = new Database();



// Connexion à la base de données :

$DB->connect();

Une requête ce fait alors de la sorte :


$DB->query("REQUETE")

Pour changer de SGBD, il suffit alors de coder de nouveaux drivers et de changer une variable
L'utilisation de drivers prend légèrement plus de temps pour lancer le développement, mais les mises à jour sont bien plus aisées. Alors pourquoi s'en priver ?

La prochaine étape et d'aller encore plus loin avec les couches d'abstraction en y introduisant des fonctions en plus comme celles de débugage par exemple.

Poursuivre l'aventure :

php, base de données et couche d'abstraction 1 (Principe).
php, base de données et couche d'abstraction 2 (Compteur de requêtes).
php, base de données et couche d'abstraction 3 (Driver MySQL).

Le blog de llaumgui - Balise - SGBD

php, base de données et couche d'abstraction 3 (Driver MySQL)

php, base de données et couche d'abstraction 2 (Compteur de requêtes)

php, base de données et couche d'abstraction 1 (Principe)

Qu'est ce qu'un couche d'abstraction?

Comment?