Subversion Repositories Applications.framework

Rev

Rev 340 | Rev 355 | 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 354 2011-08-08 13:28:14Z 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.*/
247 jpm 85
	protected $parametres_obligatoires = array('bdd_abstraction', 'bdd_protocole', 'bdd_serveur', 'bdd_nom',
86
		'bdd_utilisateur', 'bdd_mot_de_passe', 'bdd_encodage');
238 jpm 87
 
88
	/** Constructeur par défaut, appelé à l'initialisation. */
145 jpm 89
	public function __construct() {
241 jpm 90
		Config::verifierPresenceParametres($this->parametres_obligatoires);
133 aurelien 91
		$this->abstraction = strtolower(Config::get('bdd_abstraction'));
120 aurelien 92
		$this->type = Config::get('bdd_protocole');
93
		$this->hote = Config::get('bdd_serveur');
94
		$this->bdd_nom = Config::get('bdd_nom');
95
		$this->utilisateur = Config::get('bdd_utilisateur');
96
		$this->pass = Config::get('bdd_mot_de_passe');
97
		$this->encodage = Config::get('bdd_encodage');
98
 
99
		$this->dsn = $this->type.':dbname='.$this->bdd_nom.';host='.$this->hote;
133 aurelien 100
		$this->initialiserProtocole();
120 aurelien 101
	}
102
 
238 jpm 103
	/** Initialise les constantes de classe à leur bonne valeur et déclenche une erreur si le protocole n'est pas bien défini. */
104
	protected function initialiserProtocole() {
133 aurelien 105
		switch ($this->abstraction) {
219 jpm 106
			case self::ABSTRACTION_PDO :
238 jpm 107
				$this->ASSOC = PDO::FETCH_ASSOC;
108
				$this->OBJECT = PDO::FETCH_CLASS;
219 jpm 109
				break;
110
			case self::ABSTRACTION_MYSQL :
238 jpm 111
				$this->ASSOC = 'mysql_fetch_assoc';
112
				$this->OBJECT = 'mysql_fetch_object';
219 jpm 113
				break;
114
			case self::ABSTRACTION_MYSQLI :
238 jpm 115
				$this->ASSOC = 'fetch_assoc';
116
				$this->OBJECT = 'fetch_object';
219 jpm 117
				break;
118
			case self::ABSTRACTION_SQLITE3 :
238 jpm 119
				$this->ASSOC = 'SQLITE3_ASSOC';
120
				$this->OBJECT = 'SQLITE3_OBJECT';
219 jpm 121
				break;
133 aurelien 122
			default:
238 jpm 123
				$m = "Erreur : l'abstraction '{$this->abstraction}' n'est pas prise en charge";
124
				trigger_error($m, E_USER_WARNING);
133 aurelien 125
		}
238 jpm 126
	}
127
 
128
	/**
129
	 * Connection à la base de données en utilisant les informations fournies par
130
	 * le fichier de configuration.
131
	 * Cette méthode est private et final car elle n'a pas vocation a être appelée par l'utilisateur.
132
	 */
133
	protected function connecter() {
134
		if ($this->connexion == null) {
135
			switch ($this->abstraction) {
136
				case self::ABSTRACTION_PDO :
137
					try {
138
						$this->connexion = new PDO($this->dsn, $this->utilisateur, $this->pass);
354 jpm 139
						$this->connexion->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
238 jpm 140
					} catch (PDOException $e) {
141
						$e = sprintf(self::ERREUR_CONNEXION_TPL, $e->getMessage());
142
						trigger_error($e, E_USER_WARNING);
143
					}
144
					break;
145
				case self::ABSTRACTION_MYSQL :
146
					$this->connexion = mysql_connect($this->hote, $this->utilisateur, $this->pass);
147
					if ($this->connexion !== false) {
148
						$selection = mysql_select_db($this->bdd_nom, $this->connexion);
149
						if ($selection === false) {
150
							$e = sprintf(self::ERREUR_SELECTION_BDD_TPL, mysql_error());
151
							trigger_error($e, E_USER_WARNING);
152
						}
153
					} else {
154
						$e = sprintf(self::ERREUR_CONNEXION_TPL, mysql_error());
155
						trigger_error($e, E_USER_WARNING);
156
					}
157
					break;
158
				case self::ABSTRACTION_MYSQLI :
159
					$this->connexion = @new mysqli($this->hote, $this->utilisateur, $this->pass, $this->bdd_nom);
160
					if ($this->connexion->connect_errno) {
161
						$e = sprintf(self::ERREUR_CONNEXION_TPL, $this->connexion->connect_error);
162
						trigger_error($e, E_USER_WARNING);
163
					}
164
					break;
165
				case self::ABSTRACTION_SQLITE3 :
166
					// cas particulier de sqllite, on considère que le nom de la base de données correspond au fichier à ouvrir
167
					$this->connexion = new SQLite3($this->bdd_nom);
168
					if (!$this->connexion) {
169
						$e = sprintf(self::ERREUR_CONNEXION_TPL, '');
170
						trigger_error($e, E_USER_WARNING);
171
					}
172
					break;
173
				default:
174
					$this->connexion = null;
175
			}
176
 
177
			if ($this->encodage != null) {
178
				$this->requete("SET names '".$this->encodage."'");
179
			}
133 aurelien 180
		}
181
	}
238 jpm 182
 
133 aurelien 183
	/**
239 jpm 184
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see requeter
185
	 */
186
	final protected function requete($requete) {
329 delphine 187
		return $this->requeter($requete);
239 jpm 188
	}
189
 
190
	/**
238 jpm 191
	 * Execute une requête et retourne le résultat tel que renvoyé par l'abstraction courante.
120 aurelien 192
	 *
238 jpm 193
	 * @param string la requête à effectuer
194
	 * @return mixed un objet contenant le résultat de la requête
120 aurelien 195
	 */
239 jpm 196
	public function requeter($requete) {
238 jpm 197
		$this->connecter();
198
 
133 aurelien 199
		$retour = null;
200
		switch ($this->abstraction) {
219 jpm 201
			case self::ABSTRACTION_PDO :
202
				try {
203
					$retour = $this->connexion->query($requete);
204
				} catch (PDOException $e) {
205
					$m = sprintf(self::ERREUR_REQUETE_TPL, $e->getFile(), $e->getLine(), $e->getMessage(), $requete);
206
					trigger_error($m, E_USER_WARNING);
207
				}
140 jpm 208
				break;
219 jpm 209
			case self::ABSTRACTION_MYSQL :
210
				$retour = mysql_query($requete, $this->connexion);
140 jpm 211
				break;
219 jpm 212
			case self::ABSTRACTION_MYSQLI :
133 aurelien 213
				$retour = $this->connexion->query($requete);
140 jpm 214
				break;
219 jpm 215
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 216
				$retour = $this->connexion->exec($requete);
140 jpm 217
				break;
133 aurelien 218
		}
219
		return $retour;
120 aurelien 220
	}
239 jpm 221
 
238 jpm 222
	/**
239 jpm 223
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see recuperer
224
	 */
225
	final protected function requeteUn($requete, $mode = self::MODE_ASSOC) {
226
		return $this->recuperer($requete, $mode);
227
	}
228
 
229
	/**
238 jpm 230
	 * Execute une requête et retourne le premier résultat sous forme de tableau (par défaut) ou d'objet.
231
	 * 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.
232
	 *
233
	 * @param string la requête à effectuer
234
	 * @param string le mode de retour ASSOC (Bdd::MODE_ASSOC) pour un tableau ou OBJECT (Bdd::MODE_OBJET) pour un objet.
235
	 * @return mixed un objet ou un tableau contenant le résultat de la requête
236
	 */
239 jpm 237
	public function recuperer($requete, $mode = self::MODE_ASSOC) {
238 jpm 238
		$this->connecter();
133 aurelien 239
 
240
		$retour = null;
241
		switch ($this->abstraction) {
219 jpm 242
			case self::ABSTRACTION_PDO :
173 aurelien 243
				try {
238 jpm 244
					$resultat = $this->connexion->query($requete);
245
					$retour = $resultat->fetch($this->$mode);
173 aurelien 246
				} catch (PDOException $e) {
219 jpm 247
					$m = sprintf(self::ERREUR_REQUETE_TPL, $e->getFile(), $e->getLine(), $e->getMessage(), $requete);
248
					trigger_error($m, E_USER_WARNING);
173 aurelien 249
				}
140 jpm 250
				break;
219 jpm 251
			case self::ABSTRACTION_MYSQL :
238 jpm 252
				$res = mysql_query($requete, $this->connexion);
133 aurelien 253
				$fonction_fetch = $this->$mode;
254
				$retour = $fonction_fetch($res);
140 jpm 255
				break;
219 jpm 256
			case self::ABSTRACTION_MYSQLI :
133 aurelien 257
				$res = $this->connexion->query($requete);
258
				$fonction_fetch = $this->$mode;
259
				$retour = $res->$fonction_fetch();
140 jpm 260
				break;
219 jpm 261
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 262
				$retour = $this->connexion->querySingle($requete);
140 jpm 263
				break;
133 aurelien 264
		}
265
		return $retour;
120 aurelien 266
	}
239 jpm 267
 
238 jpm 268
	/**
239 jpm 269
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see recupererTous
270
	 */
271
	final protected function requeteTous($requete, $mode = self::MODE_ASSOC) {
272
		return $this->recupererTous($requete, $mode);
273
	}
274
 
275
	/**
238 jpm 276
	 * Execute une requête et retourne un tableau de résultats. Un résultat peut être présentés sous forme
277
	 * de tableau (par défaut) ou d'objet.
278
	 * Les noms des champs de la base de données correspondent aux noms des clés du tableau résultat ou
279
	 * aux noms des attributs de l'objet résultat.
280
	 *
281
	 * @param string la requête à effectuer
282
	 * @param string le mode de retour des résultats : ASSOC (Bdd::MODE_ASSOC) pour un tableau ou OBJECT (Bdd::MODE_OBJET) pour un objet.
283
	 * @return array un tableau contenant les résultats sous forme d'objets ou de tableau (par défaut).
284
	 */
239 jpm 285
	public function recupererTous($requete, $mode = self::MODE_ASSOC) {
238 jpm 286
		$this->connecter();
239 jpm 287
 
133 aurelien 288
		$retour = null;
289
		switch ($this->abstraction) {
219 jpm 290
			case self::ABSTRACTION_PDO :
143 jpm 291
				try {
238 jpm 292
					$resultat = $this->connexion->query($requete);
293
					if ($resultat !== false) {
294
						$retour = $resultat->fetchAll($this->$mode);
143 jpm 295
					} else {
296
						$retour = false;
297
					}
298
				} catch (PDOException $e) {
219 jpm 299
					$m = sprintf(self::ERREUR_REQUETE_TPL, $e->getFile(), $e->getLine(), $e->getMessage(), $requete);
300
					trigger_error($m, E_USER_WARNING);
140 jpm 301
				}
302
				break;
219 jpm 303
			case self::ABSTRACTION_MYSQL :
238 jpm 304
				$resultat = mysql_query($requete, $this->connexion);
133 aurelien 305
				$fonction_fetch = $this->$mode;
238 jpm 306
				while ($ligne = $fonction_fetch($resultat)) {
133 aurelien 307
					$retour[] = $ligne;
308
				}
140 jpm 309
				break;
219 jpm 310
			case self::ABSTRACTION_MYSQLI :
238 jpm 311
				$resultat = $this->connexion->query($requete);
133 aurelien 312
				$function_fetch = $this->$mode;
238 jpm 313
				while ($ligne = $resultat->$function_fetch()) {
133 aurelien 314
					$retour[] = $ligne;
315
				}
140 jpm 316
				break;
219 jpm 317
			case self::ABSTRACTION_SQLITE3 :
238 jpm 318
				$resultat = $this->connexion->query($requete);
319
				while ($ligne = $resultat->fetch_array($this->ASSOC)) {
219 jpm 320
					if ($mode == self::MODE_OBJET) {
321
						// Cas particulier de sqllite qui n'a pas de fonction fetch_object
133 aurelien 322
						$ligneObjet = new stdClass();
140 jpm 323
						foreach ($ligne as $colonne => $valeur) {
133 aurelien 324
							$ligneObjet->$colonne = $valeur;
325
						}
219 jpm 326
						$ligne = $ligneObjet;
133 aurelien 327
					}
219 jpm 328
					$retour[] = $ligne;
133 aurelien 329
				}
140 jpm 330
				break;
133 aurelien 331
		}
332
		return $retour;
333
	}
334
 
120 aurelien 335
	/**
238 jpm 336
	 * Protège une chaine de caractères avant l'insertion dans la base de données (ajout de quotes ou guillemets).
337
	 * @param string la chaine à protéger
338
	 * @return string la chaine protégée
120 aurelien 339
	 */
238 jpm 340
	public function proteger($chaine) {
341
		$this->connecter();
133 aurelien 342
 
343
		$retour = $chaine;
344
		switch ($this->abstraction) {
219 jpm 345
			case self::ABSTRACTION_PDO :
133 aurelien 346
				$retour = $this->connexion->quote($chaine);
140 jpm 347
				break;
219 jpm 348
			case self::ABSTRACTION_MYSQL :
133 aurelien 349
				$retour = '"'.mysql_real_escape_string($chaine, $this->connexion).'"';
140 jpm 350
				break;
219 jpm 351
			case self::ABSTRACTION_MYSQLI :
133 aurelien 352
				$retour = '"'.$this->connexion->real_escape_string($chaine).'"';
140 jpm 353
				break;
219 jpm 354
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 355
				$retour = $this->connexion->escapeString($chaine);
140 jpm 356
				break;
133 aurelien 357
		}
358
		return $retour;
120 aurelien 359
	}
360
 
361
	/**
239 jpm 362
	 * 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
363
	 * le cas de PDO, du driver utilisé. Les méthodes utilisées pour retourner l'identifiant peuvent avoir des comportements
364
	 * différent. Consulter la documentation PHP correspondant à l'abstraction choisie avant de l'utiliser :
365
	 * @link(http://fr.php.net/manual/fr/pdo.lastinsertid.php, PDO::lastInsertId([ string $name = NULL ]))
366
	 * @link(http://php.net/manual/en/mysqli.insert-id.php, mysqli->insert_id())
367
	 * @link(http://fr.php.net/manual/fr/function.mysql-insert-id.php, mysql_insert_id())
368
	 * @link(http://fr.php.net/manual/fr/sqlite3.lastinsertrowid.php, SQLite3::lastInsertRowID())
369
	 * @param mixed un paramètre éventuel à transmettre (en fonction de l'abstraction de BDD utilisée).
370
	 * @return mixed le dernier identifiant de clé primaire ajouté dans la base de données (string ou int).
371
	 */
372
	public function recupererIdDernierAjout($parametres = null) {
373
		$this->connecter();
374
 
375
		$retour = $chaine;
376
		switch ($this->abstraction) {
377
			case self::ABSTRACTION_PDO :
378
				$retour = $this->connexion->lastInsertId($parametres);
379
				break;
380
			case self::ABSTRACTION_MYSQL :
381
				$retour = mysql_insert_id($this->connexion);
382
				break;
383
			case self::ABSTRACTION_MYSQLI :
384
				$retour = $this->connexion->insert_id();
385
				break;
386
			case self::ABSTRACTION_SQLITE3 :
387
				$retour = $this->connexion->lastInsertRowID();
388
				break;
389
		}
390
		return $retour;
391
	}
392
 
393
	/**
219 jpm 394
	 * Destructeur de classe, se contente de fermer explicitement la connexion à la base de donnée.
120 aurelien 395
	 */
247 jpm 396
	public function __destruct() {
340 jpm 397
		if (isset($this->connexion)) {
398
			switch ($this->abstraction) {
399
				case self::ABSTRACTION_PDO :
400
					$this->connexion = null;
401
					break;
402
				case self::ABSTRACTION_MYSQL :
403
					if (isset($this->connexion)) {
404
						return mysql_close($this->connexion);
405
					}
406
					break;
407
				case self::ABSTRACTION_MYSQLI :
408
					$this->connexion->close();
409
					break;
410
				case self::ABSTRACTION_SQLITE3 :
411
					$this->connexion->close();
412
					break;
413
			}
120 aurelien 414
		}
415
	}
5 aurelien 416
}
417
?>