Une classe d'accès aux données (DAO) en php générique

Mise à jour le 01 Décembre 2014
Je vous invite à utiliser l'ORM Doctrine
link: http://www.doctrine-project.org/projects/orm.html


Le but est d'écrire une classe d'accès aux données en php générique, ça permet d'unifier le traitement et la nomenclature des méthodes d'accès aux données dans un seul projet et ça permet évidement une bonne maintenance de code.

1- Nous commençons tout d'abord par une classe de connexion.
  C'est une classe simple, qui implémente généralement le design pattern SINGLETON, voilà un exemple:
  (Extrait et disponible sur internet) ; le besoin d'implémentation du Singleton vient du fait:
  - La volonté de travailler sur une seule connexion BD (pour les commit et les rollback)
  - Eviter la gestion lourde et couteuse de la création et destruction de connexions aux bd.

<?php

 if (!defined('ACCESS')) die ("restricted access");

/**

 * Classe implémentant le singleton pour PDO

 * @author Savageman

 */



class Connexion extends PDO {

private static $_instance;



/* Constructeur : héritage public obligatoire par héritage de PDO */

public function __construct( ) {

}

// End of Connexion::__construct() */



/* Singleton */

public static function getInstance() {

if (!isset(self::$_instance)) {

try {

self::$_instance = new PDO("mysql:host=localhost;dbname=voiture" , "root" , "mysql");

 } catch (PDOException $e) {

 echo $e;

 die ('SQL Error');

 }

 }

 return self::$_instance;

}

// End of Connexion::getInstance() */

}

?>

2- Classe générique Dao:  
 Dans ce cadre j'ai supposé que les tables sujettes à des manipulations sont des tables à une PK simple, et la classe suivante ne tient pas compte des clés primaires composées.
 Bien que les clés primaires composées existent et continueront à exister, il n'est pas recommandé de les manipuler du fait au niveau développement :
 La lourdeur des jointures à N clés   Classes POJO complexe avec des EmbeddedId (Java-Hibernate)   La volonté de séparation entre les clés techniques (de développement) et les vraies clés de données.   Et comme solution pour conserver son MPD et éviter ces manipulations, se contenter de la création  d'un champ Id (auto-incremente ou sequence etc...) comme pk, et transformer les contraintes PK en des contraintes UNIQUE pour préserver l'unicité. Revenons à notre classe; Une classe D'accès aux données doit savoir le nom de la table cible, la connexion à la BD. Une bonne conception mettant en oeuvre une implémentation MVC et la sépération entre les couches, nécéssite des classes Model et un mapping entre les Models et les colonnes de la table. Pour cette première version, nous allons faire une chose simple: voila le code:

<?php

/**

* Classe génériques pour les dao

*/

if (!defined('ACCESS')) die ("restricted access");



class GenericDao {


 /**

 * PDO Connection

 */

 protected $connexion;

 /**

 * Table name

 */

 var $tableName;

 /**

 * Nom de la colonne PK

 */

 protected $idColumn;

  /**

   * Constructeur de la classe

   *

   * @param cnx : PDO Connexion si la valeur est null alors une instance du singleton sera chargée

 * @param $tableNanme : Nom de la table dans la base de données

 * @param $idColumn : Column Pk de la table

   * @return void

   */

  public function __construct($cnx,$tableName,$idColumn) { 

 if($cnx == null){

 require_once(dirname(__FILE__).'/Connexion.class.php');

 $this->connexion = Connexion::getInstance();

 }else{

 $this->connexion = $cnx;

 } 

 

 $this->tableName = $tableName;

 $this->idColumn = $idColumn;

  }

 

 /**

   * Méthode qui retourne tous les éléments d'une table

   * @return les données de la table

   */

 public function findAll() {



 $sql = "SELECT * FROM ".$this->tableName;

 $requete = $this->connexion->prepare($sql); 

 if($requete->execute())

 {

 if($donnees = $requete->fetchAll())
   return $donnees;

 }

 else

 {

  return null;

 }

 }

 /**

   * Méthode qui retourne tous les éléments d'une table

   * @return les données de la table

   */

 public function findAllAdvanced($sortingExpr,$from,$to) {

 $sql = "SELECT * FROM ".$this->tableName;

 if($sortingExpr != null){

 $sql.=" ORDER BY ".$sortingExpr;

 }

 if($from !=null && $to != null){

 $sql .=" LIMIT ".$from.",".$to;

 }

 $requete = $this->connexion->prepare($sql);

 if($requete->execute()){

 if($donnees = $requete->fetch())
   return $donnees;

 }

 else{

  return null;

 }

 }

 /**

   * Méthode qui retourne un élément d'une table selon la valeur de la PK

 * @param $pkVal : La valeur de la PK

   * @return l'enregistrement voulu

   */

 public function findById($pkVal){

 $sql = "SELECT * FROM ".$this->tableName." WHERE ".$this->idColumn." = :myVal";

 $requete = $this->connexion->prepare($sql);

 $requete->bindValue(':myVal', $pkVal);

 if($requete->execute()){

 if($donnees = $requete->fetch())

return $donnees;

 }

 else{

  return null;

 } 

 }

 /**

   * Méthode qui supprime un élément d'une table selon la valeur de la PK

 * @param $pkVal : La valeur de la PK

   * @return

   */

 public function deleteById($pkVal){

 $sql = "DELETE FROM ".$this->tableName." WHERE ".$this->idColumn." = :myVal";

 $requete = $this->connexion->prepare($sql);

 $requete->bindValue(':myVal', $pkVal);

 if($requete->execute()){

 return true;

 }

 else{

  return false;

 } 

 } 

 /**

  * Met à jour des colonnes specifiques de la table

  * @param array $colNames tableau contenant les noms des colonnes à modifier

  * @param array $newVals tableau contenant les nouvelles valeurs

  * @param ? valeur de la pk

  */

 public function updateColumns($colNames,$newVals,$pkVal){

 $sql = "Update ".$this->tableName." SET ";

 for($i=0;$i<count($colNames);$i++){

 $sql.=$colNames[$i]. " = :v".$i;

 if($i<count($colNames)-1){

 $sql.=",";

 } 

 }

 $sql.= " where ".$this->idColumn ." = :myVal"; 



 $requete = $this->connexion->prepare($sql);

 for($i=0;$i<count($colNames);$i++){ 

 $requete->bindValue(':v'.$i, $newVals[$i]); 

 }

 

 $requete->bindValue(':myVal', $pkVal);

 if($requete->execute()){

 return true;

 }

 else{

  return false;

 } 

 }

 }

?>

3- Exemple d'utilisation:

<?php

 /**

* Classe Dao pour les categories<br/>

if (!defined('ACCESS')) die ("restricted access");
 require_once(dirname(__FILE__).'/GenericDao.class.php');

 class BannerDao extends GenericDao{

   public function __construct($cnx) { 

parent::__construct($cnx,"Banner","bnr_id"); 

   }

 }

 ?>