Subversion Repositories Applications.framework

Rev

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