Subversion Repositories Applications.framework

Rev

Rev 239 | Rev 247 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
5 aurelien 1 
<?php
105 aurelien 2 
// declare(encoding='UTF-8');
5 aurelien 3 
/**
238 jpm 4 
 * Classe Bdd, d'accés au base de données.
5 
 * Elle fait office d'abstraction légère de base de données en utilisant diverses possibilités d'accès aux
6 
 * bases de données (PDO, mysql, mysqli, SQLite3).
7 
 * Les valeurs pour le paramètre 'bdd_abstraction' du fichier config.ini sont : pdo, mysql, mysqli, sqlite3
8 
 * Vous pouvez aussi utiliser : "php:Bdd::ABSTRACTION_PDO","php:Bdd::ABSTRACTION_MYSQL", "php:Bdd::ABSTRACTION_MYSQLI",
9 
 * "php:Bdd::ABSTRACTION_SQLITE3".
10 
 * Elle peut être étendue, pour ajouter le support d'autres bases de données où prendre en compte des méthodes spécifique à
11 
 * un type d'abstraction.
12 
 *
13 
 * @category	php 5.2
14 
 * @package	Framework
15 
 * @author		Aurélien PERONNET <aurelien@tela-botanica.org>
16 
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
241 jpm 17 
 * @copyright	Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
238 jpm 18 
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
19 
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
20 
 * @version	$Id: Bdd.php 241 2010-12-06 15:19:07Z jpm $
21 
 * @link		/doc/framework/
22 
 */
23 
class Bdd {
219 jpm 24 
	/** Constante stockant le squelette du message en cas d'erreur de requête sql. */
25 
	const ERREUR_REQUETE_TPL = 'Requête echec.\nFichier : %s.\nLigne : %s.\nMessage : %s.\nRequête : %s';
26 
 
27 
	/** Constante stockant le squelette du message en cas d'erreur de connexion à la base de données. */
28 
	const ERREUR_CONNEXION_TPL = 'Erreur de connexion à la base de données, vérifiez les paramètres du fichier de configuration.\nMessage : %S.';
29 
 
30 
	/** Constante stockant le squelette du message en cas d'erreur de sélection de la base de données. */
231 delphine 31 
	const ERREUR_SELECTION_BDD_TPL = 'Erreur de sélection de la base de données, vérifiez les paramètres du fichier de configuration.\nMessage : %S.';
219 jpm 32 
 
33 
	/** Constante stockant le code pour l'abstraction de PDO. */
34 
	const ABSTRACTION_PDO = 'pdo';
35 
 
36 
	/** Constante stockant le code pour l'abstraction de mysql. */
37 
	const ABSTRACTION_MYSQL = 'mysql';
38 
 
39 
	/** Constante stockant le code pour l'abstraction de mysqli. */
40 
	const ABSTRACTION_MYSQLI = 'mysqli';
41 
 
42 
	/** Constante stockant le code pour l'abstraction de SQLite3. */
43 
	const ABSTRACTION_SQLITE3 = 'sqlite3';
44 
 
45 
	/** Constante stockant le code pour le mode tableau associatif des résultats des requêtes. */
46 
	const MODE_ASSOC = 'ASSOC';
47 
 
48 
	/** Constante stockant le code pour le mode objet des résultats des requêtes. */
49 
	const MODE_OBJET = 'OBJECT';
50 
 
51 
	/** Mode de fetch associatif */
238 jpm 52 
	protected $ASSOC = '';
219 jpm 53 
 
54 
	/** Mode de fetch objet */
238 jpm 55 
	protected $OBJECT = '';
133 aurelien 56 
 
219 jpm 57 
	/** abstraction de base de données utilisée */
238 jpm 58 
	protected $abstraction;
219 jpm 59 
 
60 
	/** DSN pour accéder à la base de données */
238 jpm 61 
	protected $dsn;
219 jpm 62 
 
63 
	/** Type de base de données (mysql, mysqli, etc ...) */
238 jpm 64 
	protected $type;
219 jpm 65 
 
66 
	/** Hote herbergeant la base de données */
238 jpm 67 
	protected $hote;
219 jpm 68 
 
69 
	/** Nom de la base de données à laquelle le modèle doit se connecter */
238 jpm 70 
	protected $bdd_nom;
219 jpm 71 
 
72 
	/** Nom d'utilisateur */
238 jpm 73 
	protected $utilisateur;
219 jpm 74 
 
75 
	/** Mot de passe */
238 jpm 76 
	protected $pass;
120 aurelien 77 
 
219 jpm 78 
	/** Encodage de la base de données */
238 jpm 79 
	protected $encodage = null;
219 jpm 80 
 
81 
	/** Connexion à la base de données */
238 jpm 82 
	protected $connexion = null;
5 aurelien 83 
 
238 jpm 84 
	/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/
85 
	protected $parametres_obligatoires = array('bdd_abstraction', 'bdd_protocole', 'bdd_serveur', 'bdd_nom', '');
86 
 
87 
	/** Constructeur par défaut, appelé à l'initialisation. */
145 jpm 88 
	public function __construct() {
241 jpm 89 
		Config::verifierPresenceParametres($this->parametres_obligatoires);
133 aurelien 90 
		$this->abstraction = strtolower(Config::get('bdd_abstraction'));
120 aurelien 91 
		$this->type = Config::get('bdd_protocole');
92 
		$this->hote = Config::get('bdd_serveur');
93 
		$this->bdd_nom = Config::get('bdd_nom');
94 
		$this->utilisateur = Config::get('bdd_utilisateur');
95 
		$this->pass = Config::get('bdd_mot_de_passe');
96 
		$this->encodage = Config::get('bdd_encodage');
97 
 
98 
		$this->dsn = $this->type.':dbname='.$this->bdd_nom.';host='.$this->hote;
133 aurelien 99 
		$this->initialiserProtocole();
120 aurelien 100 
	}
101 
 
238 jpm 102 
	/** Initialise les constantes de classe à leur bonne valeur et déclenche une erreur si le protocole n'est pas bien défini. */
103 
	protected function initialiserProtocole() {
133 aurelien 104 
		switch ($this->abstraction) {
219 jpm 105 
			case self::ABSTRACTION_PDO :
238 jpm 106 
				$this->ASSOC = PDO::FETCH_ASSOC;
107 
				$this->OBJECT = PDO::FETCH_CLASS;
219 jpm 108 
				break;
109 
			case self::ABSTRACTION_MYSQL :
238 jpm 110 
				$this->ASSOC = 'mysql_fetch_assoc';
111 
				$this->OBJECT = 'mysql_fetch_object';
219 jpm 112 
				break;
113 
			case self::ABSTRACTION_MYSQLI :
238 jpm 114 
				$this->ASSOC = 'fetch_assoc';
115 
				$this->OBJECT = 'fetch_object';
219 jpm 116 
				break;
117 
			case self::ABSTRACTION_SQLITE3 :
238 jpm 118 
				$this->ASSOC = 'SQLITE3_ASSOC';
119 
				$this->OBJECT = 'SQLITE3_OBJECT';
219 jpm 120 
				break;
133 aurelien 121 
			default:
238 jpm 122 
				$m = "Erreur : l'abstraction '{$this->abstraction}' n'est pas prise en charge";
123 
				trigger_error($m, E_USER_WARNING);
133 aurelien 124 
		}
238 jpm 125 
	}
126 
 
127 
	/**
128 
	 * Connection à la base de données en utilisant les informations fournies par
129 
	 * le fichier de configuration.
130 
	 * Cette méthode est private et final car elle n'a pas vocation a être appelée par l'utilisateur.
131 
	 */
132 
	protected function connecter() {
133 
		if ($this->connexion == null) {
134 
			switch ($this->abstraction) {
135 
				case self::ABSTRACTION_PDO :
136 
					try {
137 
						$this->connexion = new PDO($this->dsn, $this->utilisateur, $this->pass);
138 
					} catch (PDOException $e) {
139 
						$e = sprintf(self::ERREUR_CONNEXION_TPL, $e->getMessage());
140 
						trigger_error($e, E_USER_WARNING);
141 
					}
142 
					break;
143 
				case self::ABSTRACTION_MYSQL :
144 
					$this->connexion = mysql_connect($this->hote, $this->utilisateur, $this->pass);
145 
					if ($this->connexion !== false) {
146 
						$selection = mysql_select_db($this->bdd_nom, $this->connexion);
147 
						if ($selection === false) {
148 
							$e = sprintf(self::ERREUR_SELECTION_BDD_TPL, mysql_error());
149 
							trigger_error($e, E_USER_WARNING);
150 
						}
151 
					} else {
152 
						$e = sprintf(self::ERREUR_CONNEXION_TPL, mysql_error());
153 
						trigger_error($e, E_USER_WARNING);
154 
					}
155 
					break;
156 
				case self::ABSTRACTION_MYSQLI :
157 
					$this->connexion = @new mysqli($this->hote, $this->utilisateur, $this->pass, $this->bdd_nom);
158 
					if ($this->connexion->connect_errno) {
159 
						$e = sprintf(self::ERREUR_CONNEXION_TPL, $this->connexion->connect_error);
160 
						trigger_error($e, E_USER_WARNING);
161 
					}
162 
					break;
163 
				case self::ABSTRACTION_SQLITE3 :
164 
					// cas particulier de sqllite, on considère que le nom de la base de données correspond au fichier à ouvrir
165 
					$this->connexion = new SQLite3($this->bdd_nom);
166 
					if (!$this->connexion) {
167 
						$e = sprintf(self::ERREUR_CONNEXION_TPL, '');
168 
						trigger_error($e, E_USER_WARNING);
169 
					}
170 
					break;
171 
				default:
172 
					$this->connexion = null;
173 
			}
174 
 
175 
			if ($this->encodage != null) {
176 
				$this->requete("SET names '".$this->encodage."'");
177 
			}
133 aurelien 178 
		}
179 
	}
238 jpm 180 
 
133 aurelien 181 
	/**
239 jpm 182 
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see requeter
183 
	 */
184 
	final protected function requete($requete) {
185 
		return $this->requeter($requete, $mode);
186 
	}
187 
 
188 
	/**
238 jpm 189 
	 * Execute une requête et retourne le résultat tel que renvoyé par l'abstraction courante.
120 aurelien 190 
	 *
238 jpm 191 
	 * @param string la requête à effectuer
192 
	 * @return mixed un objet contenant le résultat de la requête
120 aurelien 193 
	 */
239 jpm 194 
	public function requeter($requete) {
238 jpm 195 
		$this->connecter();
196 
 
133 aurelien 197 
		$retour = null;
198 
		switch ($this->abstraction) {
219 jpm 199 
			case self::ABSTRACTION_PDO :
200 
				try {
201 
					$retour = $this->connexion->query($requete);
202 
				} catch (PDOException $e) {
203 
					$m = sprintf(self::ERREUR_REQUETE_TPL, $e->getFile(), $e->getLine(), $e->getMessage(), $requete);
204 
					trigger_error($m, E_USER_WARNING);
205 
				}
140 jpm 206 
				break;
219 jpm 207 
			case self::ABSTRACTION_MYSQL :
208 
				$retour = mysql_query($requete, $this->connexion);
140 jpm 209 
				break;
219 jpm 210 
			case self::ABSTRACTION_MYSQLI :
133 aurelien 211 
				$retour = $this->connexion->query($requete);
140 jpm 212 
				break;
219 jpm 213 
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 214 
				$retour = $this->connexion->exec($requete);
140 jpm 215 
				break;
133 aurelien 216 
		}
217 
		return $retour;
120 aurelien 218 
	}
239 jpm 219 
 
238 jpm 220 
	/**
239 jpm 221 
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see recuperer
222 
	 */
223 
	final protected function requeteUn($requete, $mode = self::MODE_ASSOC) {
224 
		return $this->recuperer($requete, $mode);
225 
	}
226 
 
227 
	/**
238 jpm 228 
	 * Execute une requête et retourne le premier résultat sous forme de tableau (par défaut) ou d'objet.
229 
	 * Les noms des champs de la base de données correspondent aux noms des clés du tableau ou aux noms des attributs de l'objet.
230 
	 *
231 
	 * @param string la requête à effectuer
232 
	 * @param string le mode de retour ASSOC (Bdd::MODE_ASSOC) pour un tableau ou OBJECT (Bdd::MODE_OBJET) pour un objet.
233 
	 * @return mixed un objet ou un tableau contenant le résultat de la requête
234 
	 */
239 jpm 235 
	public function recuperer($requete, $mode = self::MODE_ASSOC) {
238 jpm 236 
		$this->connecter();
133 aurelien 237 
 
238 
		$retour = null;
239 
		switch ($this->abstraction) {
219 jpm 240 
			case self::ABSTRACTION_PDO :
173 aurelien 241 
				try {
238 jpm 242 
					$resultat = $this->connexion->query($requete);
243 
					$retour = $resultat->fetch($this->$mode);
173 aurelien 244 
				} catch (PDOException $e) {
219 jpm 245 
					$m = sprintf(self::ERREUR_REQUETE_TPL, $e->getFile(), $e->getLine(), $e->getMessage(), $requete);
246 
					trigger_error($m, E_USER_WARNING);
173 aurelien 247 
				}
140 jpm 248 
				break;
219 jpm 249 
			case self::ABSTRACTION_MYSQL :
238 jpm 250 
				$res = mysql_query($requete, $this->connexion);
133 aurelien 251 
				$fonction_fetch = $this->$mode;
252 
				$retour = $fonction_fetch($res);
140 jpm 253 
				break;
219 jpm 254 
			case self::ABSTRACTION_MYSQLI :
133 aurelien 255 
				$res = $this->connexion->query($requete);
256 
				$fonction_fetch = $this->$mode;
257 
				$retour = $res->$fonction_fetch();
140 jpm 258 
				break;
219 jpm 259 
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 260 
				$retour = $this->connexion->querySingle($requete);
140 jpm 261 
				break;
133 aurelien 262 
		}
263 
		return $retour;
120 aurelien 264 
	}
239 jpm 265 
 
238 jpm 266 
	/**
239 jpm 267 
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see recupererTous
268 
	 */
269 
	final protected function requeteTous($requete, $mode = self::MODE_ASSOC) {
270 
		return $this->recupererTous($requete, $mode);
271 
	}
272 
 
273 
	/**
238 jpm 274 
	 * Execute une requête et retourne un tableau de résultats. Un résultat peut être présentés sous forme
275 
	 * de tableau (par défaut) ou d'objet.
276 
	 * Les noms des champs de la base de données correspondent aux noms des clés du tableau résultat ou
277 
	 * aux noms des attributs de l'objet résultat.
278 
	 *
279 
	 * @param string la requête à effectuer
280 
	 * @param string le mode de retour des résultats : ASSOC (Bdd::MODE_ASSOC) pour un tableau ou OBJECT (Bdd::MODE_OBJET) pour un objet.
281 
	 * @return array un tableau contenant les résultats sous forme d'objets ou de tableau (par défaut).
282 
	 */
239 jpm 283 
	public function recupererTous($requete, $mode = self::MODE_ASSOC) {
238 jpm 284 
		$this->connecter();
239 jpm 285 
 
133 aurelien 286 
		$retour = null;
287 
		switch ($this->abstraction) {
219 jpm 288 
			case self::ABSTRACTION_PDO :
143 jpm 289 
				try {
238 jpm 290 
					$resultat = $this->connexion->query($requete);
291 
					if ($resultat !== false) {
292 
						$retour = $resultat->fetchAll($this->$mode);
143 jpm 293 
					} else {
294 
						$retour = false;
295 
					}
296 
				} catch (PDOException $e) {
219 jpm 297 
					$m = sprintf(self::ERREUR_REQUETE_TPL, $e->getFile(), $e->getLine(), $e->getMessage(), $requete);
298 
					trigger_error($m, E_USER_WARNING);
140 jpm 299 
				}
300 
				break;
219 jpm 301 
			case self::ABSTRACTION_MYSQL :
238 jpm 302 
				$resultat = mysql_query($requete, $this->connexion);
133 aurelien 303 
				$fonction_fetch = $this->$mode;
238 jpm 304 
				while ($ligne = $fonction_fetch($resultat)) {
133 aurelien 305 
					$retour[] = $ligne;
306 
				}
140 jpm 307 
				break;
219 jpm 308 
			case self::ABSTRACTION_MYSQLI :
238 jpm 309 
				$resultat = $this->connexion->query($requete);
133 aurelien 310 
				$function_fetch = $this->$mode;
238 jpm 311 
				while ($ligne = $resultat->$function_fetch()) {
133 aurelien 312 
					$retour[] = $ligne;
313 
				}
140 jpm 314 
				break;
219 jpm 315 
			case self::ABSTRACTION_SQLITE3 :
238 jpm 316 
				$resultat = $this->connexion->query($requete);
317 
				while ($ligne = $resultat->fetch_array($this->ASSOC)) {
219 jpm 318 
					if ($mode == self::MODE_OBJET) {
319 
						// Cas particulier de sqllite qui n'a pas de fonction fetch_object
133 aurelien 320 
						$ligneObjet = new stdClass();
140 jpm 321 
						foreach ($ligne as $colonne => $valeur) {
133 aurelien 322 
							$ligneObjet->$colonne = $valeur;
323 
						}
219 jpm 324 
						$ligne = $ligneObjet;
133 aurelien 325 
					}
219 jpm 326 
					$retour[] = $ligne;
133 aurelien 327 
				}
140 jpm 328 
				break;
133 aurelien 329 
		}
330 
		return $retour;
331 
	}
332 
 
120 aurelien 333 
	/**
238 jpm 334 
	 * Protège une chaine de caractères avant l'insertion dans la base de données (ajout de quotes ou guillemets).
335 
	 * @param string la chaine à protéger
336 
	 * @return string la chaine protégée
120 aurelien 337 
	 */
238 jpm 338 
	public function proteger($chaine) {
339 
		$this->connecter();
133 aurelien 340 
 
341 
		$retour = $chaine;
342 
		switch ($this->abstraction) {
219 jpm 343 
			case self::ABSTRACTION_PDO :
133 aurelien 344 
				$retour = $this->connexion->quote($chaine);
140 jpm 345 
				break;
219 jpm 346 
			case self::ABSTRACTION_MYSQL :
133 aurelien 347 
				$retour = '"'.mysql_real_escape_string($chaine, $this->connexion).'"';
140 jpm 348 
				break;
219 jpm 349 
			case self::ABSTRACTION_MYSQLI :
133 aurelien 350 
				$retour = '"'.$this->connexion->real_escape_string($chaine).'"';
140 jpm 351 
				break;
219 jpm 352 
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 353 
				$retour = $this->connexion->escapeString($chaine);
140 jpm 354 
				break;
133 aurelien 355 
		}
356 
		return $retour;
120 aurelien 357 
	}
358 
 
359 
	/**
239 jpm 360 
	 * Retourne l'identifiant de la dernière ligne insérée, ou la dernière valeur d'une séquence d'objets, dépendamment, dans
361 
	 * le cas de PDO, du driver utilisé. Les méthodes utilisées pour retourner l'identifiant peuvent avoir des comportements
362 
	 * différent. Consulter la documentation PHP correspondant à l'abstraction choisie avant de l'utiliser :
363 
	 * @link(http://fr.php.net/manual/fr/pdo.lastinsertid.php, PDO::lastInsertId([ string $name = NULL ]))
364 
	 * @link(http://php.net/manual/en/mysqli.insert-id.php, mysqli->insert_id())
365 
	 * @link(http://fr.php.net/manual/fr/function.mysql-insert-id.php, mysql_insert_id())
366 
	 * @link(http://fr.php.net/manual/fr/sqlite3.lastinsertrowid.php, SQLite3::lastInsertRowID())
367 
	 * @param mixed un paramètre éventuel à transmettre (en fonction de l'abstraction de BDD utilisée).
368 
	 * @return mixed le dernier identifiant de clé primaire ajouté dans la base de données (string ou int).
369 
	 */
370 
	public function recupererIdDernierAjout($parametres = null) {
371 
		$this->connecter();
372 
 
373 
		$retour = $chaine;
374 
		switch ($this->abstraction) {
375 
			case self::ABSTRACTION_PDO :
376 
				$retour = $this->connexion->lastInsertId($parametres);
377 
				break;
378 
			case self::ABSTRACTION_MYSQL :
379 
				$retour = mysql_insert_id($this->connexion);
380 
				break;
381 
			case self::ABSTRACTION_MYSQLI :
382 
				$retour = $this->connexion->insert_id();
383 
				break;
384 
			case self::ABSTRACTION_SQLITE3 :
385 
				$retour = $this->connexion->lastInsertRowID();
386 
				break;
387 
		}
388 
		return $retour;
389 
	}
390 
 
391 
	/**
219 jpm 392 
	 * Destructeur de classe, se contente de fermer explicitement la connexion à la base de donnée.
120 aurelien 393 
	 */
238 jpm 394 
	protected function __destruct() {
133 aurelien 395 
		switch ($this->abstraction) {
219 jpm 396 
			case self::ABSTRACTION_PDO :
133 aurelien 397 
				$this->connexion = null;
140 jpm 398 
				break;
219 jpm 399 
			case self::ABSTRACTION_MYSQL :
133 aurelien 400 
				return mysql_close($this->connexion);
140 jpm 401 
				break;
219 jpm 402 
			case self::ABSTRACTION_MYSQLI :
133 aurelien 403 
				$this->connexion->close();
140 jpm 404 
				break;
219 jpm 405 
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 406 
				$this->connexion->close();
140 jpm 407 
				break;
120 aurelien 408 
		}
409 
	}
5 aurelien 410 
}
411 
?>