Subversion Repositories Applications.framework

Rev

Rev 355 | Rev 403 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 355 Rev 401
Line 1... Line 1...
1
<?php
1
<?php
2
// declare(encoding='UTF-8');
2
// declare(encoding='UTF-8');
3
/**
3
/**
4
 * Classe Bdd, d'accés au base de données.
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 
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).
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
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",
8
 * Vous pouvez aussi utiliser : "php:Bdd::ABSTRACTION_PDO","php:Bdd::ABSTRACTION_MYSQL", "php:Bdd::ABSTRACTION_MYSQLI",
9
 * "php:Bdd::ABSTRACTION_SQLITE3".
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 à
10
 * Elle peut être étendue, pour ajouter le support d'autres bases de données où prendre en compte des méthodes spécifique à
Line 15... Line 15...
15
 * @author		Aurélien PERONNET <aurelien@tela-botanica.org>
15
 * @author		Aurélien PERONNET <aurelien@tela-botanica.org>
16
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
16
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
17
 * @copyright	Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
17
 * @copyright	Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
18
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
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
19
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
20
 * @version	$Id: Bdd.php 355 2011-08-08 13:31:31Z jpm $
20
 * @version	$Id: Bdd.php 401 2011-12-29 10:44:38Z jpm $
21
 * @link		/doc/framework/
21
 * @link		/doc/framework/
22
 */
22
 */
23
class Bdd {
23
class Bdd {
24
	/** Constante stockant le squelette du message en cas d'erreur de requête sql. */
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';
25
	const ERREUR_REQUETE_TPL = 'Requête echec.\nFichier : %s.\nLigne : %s.\nMessage : %s.\nRequête : %s';
26
	
26
 
27
	/** Constante stockant le squelette du message en cas d'erreur de connexion à la base de données. */
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.';
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
	
29
 
30
	/** Constante stockant le squelette du message en cas d'erreur de sélection de la base de données. */
30
	/** Constante stockant le squelette du message en cas d'erreur de sélection de la base de données. */
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.';
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.';
32
	
32
 
33
	/** Constante stockant le code pour l'abstraction de PDO. */
33
	/** Constante stockant le code pour l'abstraction de PDO. */
34
	const ABSTRACTION_PDO = 'pdo';
34
	const ABSTRACTION_PDO = 'pdo';
35
	
35
 
36
	/** Constante stockant le code pour l'abstraction de mysql. */
36
	/** Constante stockant le code pour l'abstraction de mysql. */
37
	const ABSTRACTION_MYSQL = 'mysql';
37
	const ABSTRACTION_MYSQL = 'mysql';
38
	
38
 
39
	/** Constante stockant le code pour l'abstraction de mysqli. */
39
	/** Constante stockant le code pour l'abstraction de mysqli. */
40
	const ABSTRACTION_MYSQLI = 'mysqli';
40
	const ABSTRACTION_MYSQLI = 'mysqli';
41
	
41
 
42
	/** Constante stockant le code pour l'abstraction de SQLite3. */
42
	/** Constante stockant le code pour l'abstraction de SQLite3. */
43
	const ABSTRACTION_SQLITE3 = 'sqlite3';
43
	const ABSTRACTION_SQLITE3 = 'sqlite3';
44
	
44
 
45
	/** Constante stockant le code pour le mode tableau associatif des résultats des requêtes. */
45
	/** Constante stockant le code pour le mode tableau associatif des résultats des requêtes. */
46
	const MODE_ASSOC = 'ASSOC';
46
	const MODE_ASSOC = 'ASSOC';
47
	
47
 
48
	/** Constante stockant le code pour le mode objet des résultats des requêtes. */
48
	/** Constante stockant le code pour le mode objet des résultats des requêtes. */
49
	const MODE_OBJET = 'OBJECT';
49
	const MODE_OBJET = 'OBJECT';
50
	
50
 
51
	/** Mode de fetch associatif */
51
	/** Mode de fetch associatif */
52
	protected $ASSOC = '';
52
	protected $ASSOC = '';
53
	
53
 
54
	/** Mode de fetch objet */
54
	/** Mode de fetch objet */
55
	protected $OBJECT = '';
55
	protected $OBJECT = '';
Line 56... Line 56...
56
 
56
 
57
	/** abstraction de base de données utilisée */
57
	/** abstraction de base de données utilisée */
58
	protected $abstraction;
58
	protected $abstraction;
59
	
59
 
60
	/** DSN pour accéder à la base de données */
60
	/** DSN pour accéder à la base de données */
61
	protected $dsn;
61
	protected $dsn;
62
	
62
 
63
	/** Type de base de données (mysql, mysqli, etc ...) */
63
	/** Type de base de données (mysql, mysqli, etc ...) */
64
	protected $type;
64
	protected $type;
65
	
65
 
66
	/** Hote herbergeant la base de données */
66
	/** Hote herbergeant la base de données */
67
	protected $hote;
67
	protected $hote;
68
	
68
 
69
	/** Nom de la base de données à laquelle le modèle doit se connecter */
69
	/** Nom de la base de données à laquelle le modèle doit se connecter */
70
	protected $bdd_nom;
70
	protected $bdd_nom;
71
	
71
 
72
	/** Nom d'utilisateur */
72
	/** Nom d'utilisateur */
73
	protected $utilisateur;
73
	protected $utilisateur;
74
	
74
 
75
	/** Mot de passe */
75
	/** Mot de passe */
Line 76... Line 76...
76
	protected $pass;
76
	protected $pass;
77
 
77
 
78
	/** Encodage de la base de données */
78
	/** Encodage de la base de données */
79
	protected $encodage = null;
79
	protected $encodage = null;
80
	
80
 
Line 81... Line 81...
81
	/** Connexion à la base de données */
81
	/** Connexion à la base de données */
82
	protected $connexion = null;
82
	protected $connexion = null;
83
 
83
 
84
	/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/
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', 
85
	protected $parametres_obligatoires = array('bdd_abstraction', 'bdd_protocole', 'bdd_serveur', 'bdd_nom',
86
		'bdd_utilisateur', 'bdd_mot_de_passe', 'bdd_encodage');
86
		'bdd_utilisateur', 'bdd_mot_de_passe', 'bdd_encodage');
87
	
87
 
88
	/** Constructeur par défaut, appelé à l'initialisation. */
88
	/** Constructeur par défaut, appelé à l'initialisation. */
89
	public function __construct() {
89
	public function __construct() {
Line 94... Line 94...
94
		$this->bdd_nom = Config::get('bdd_nom');
94
		$this->bdd_nom = Config::get('bdd_nom');
95
		$this->utilisateur = Config::get('bdd_utilisateur');
95
		$this->utilisateur = Config::get('bdd_utilisateur');
96
		$this->pass = Config::get('bdd_mot_de_passe');
96
		$this->pass = Config::get('bdd_mot_de_passe');
97
		$this->encodage = Config::get('bdd_encodage');
97
		$this->encodage = Config::get('bdd_encodage');
Line -... Line 98...
-
 
98
 
-
 
99
		if ($this->type == 'sqlite' || $this->type == 'sqlite2') {
-
 
100
			$this->dsn = $this->type.':'.$this->hote;
98
 
101
		} else {
-
 
102
			$this->dsn = $this->type.':dbname='.$this->bdd_nom.';host='.$this->hote;
99
		$this->dsn = $this->type.':dbname='.$this->bdd_nom.';host='.$this->hote;
103
		}
100
		$this->initialiserProtocole();
104
		$this->initialiserProtocole();
Line 101... Line 105...
101
	}
105
	}
102
 
106
 
Line 122... Line 126...
122
			default:
126
			default:
123
				$m = "Erreur : l'abstraction '{$this->abstraction}' n'est pas prise en charge";
127
				$m = "Erreur : l'abstraction '{$this->abstraction}' n'est pas prise en charge";
124
				trigger_error($m, E_USER_WARNING);
128
				trigger_error($m, E_USER_WARNING);
125
		}
129
		}
126
	}
130
	}
127
	
131
 
128
	/**
132
	/**
129
	 * Connection à la base de données en utilisant les informations fournies par
133
	 * Connection à la base de données en utilisant les informations fournies par
130
	 * le fichier de configuration.
134
	 * 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.
135
	 * Cette méthode est private et final car elle n'a pas vocation a être appelée par l'utilisateur.
132
	 */
136
	 */
Line 139... Line 143...
139
						$this->connexion->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
143
						$this->connexion->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
140
					} catch (PDOException $e) {
144
					} catch (PDOException $e) {
141
						$e = sprintf(self::ERREUR_CONNEXION_TPL, $e->getMessage());
145
						$e = sprintf(self::ERREUR_CONNEXION_TPL, $e->getMessage());
142
						trigger_error($e, E_USER_WARNING);
146
						trigger_error($e, E_USER_WARNING);
143
					}
147
					}
-
 
148
					if ($this->encodage != null && $this->type == 'mysql') {
-
 
149
						$this->requeter("SET names '".$this->encodage."'");
-
 
150
					} else if ($this->type == 'sqlite') {
-
 
151
						$this->requeter("PRAGMA case_sensitive_like = false");
-
 
152
					}
144
					break;
153
					break;
145
				case self::ABSTRACTION_MYSQL :
154
				case self::ABSTRACTION_MYSQL :
146
					$this->connexion = mysql_connect($this->hote, $this->utilisateur, $this->pass);
155
					$this->connexion = mysql_connect($this->hote, $this->utilisateur, $this->pass);
147
					if ($this->connexion !== false) {
156
					if ($this->connexion !== false) {
148
						$selection = mysql_select_db($this->bdd_nom, $this->connexion);
157
						$selection = mysql_select_db($this->bdd_nom, $this->connexion);
Line 152... Line 161...
152
						}
161
						}
153
					} else {
162
					} else {
154
						$e = sprintf(self::ERREUR_CONNEXION_TPL, mysql_error());
163
						$e = sprintf(self::ERREUR_CONNEXION_TPL, mysql_error());
155
						trigger_error($e, E_USER_WARNING);
164
						trigger_error($e, E_USER_WARNING);
156
					}
165
					}
-
 
166
					if ($this->encodage != null) {
-
 
167
						$this->requeter("SET names '".$this->encodage."'");
-
 
168
					}
157
					break;
169
					break;
158
				case self::ABSTRACTION_MYSQLI :
170
				case self::ABSTRACTION_MYSQLI :
159
					$this->connexion = @new mysqli($this->hote, $this->utilisateur, $this->pass, $this->bdd_nom);
171
					$this->connexion = @new mysqli($this->hote, $this->utilisateur, $this->pass, $this->bdd_nom);
160
					if ($this->connexion->connect_errno) {
172
					if ($this->connexion->connect_errno) {
161
						$e = sprintf(self::ERREUR_CONNEXION_TPL, $this->connexion->connect_error);
173
						$e = sprintf(self::ERREUR_CONNEXION_TPL, $this->connexion->connect_error);
162
						trigger_error($e, E_USER_WARNING);
174
						trigger_error($e, E_USER_WARNING);
163
					}
175
					}
-
 
176
					if ($this->encodage != null) {
-
 
177
						$this->requeter("SET names '".$this->encodage."'");
-
 
178
					}
164
					break;
179
					break;
165
				case self::ABSTRACTION_SQLITE3 :
180
				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
181
					// 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);
182
					$this->connexion = new SQLite3($this->bdd_nom);
168
					if (!$this->connexion) {
183
					if (!$this->connexion) {
169
						$e = sprintf(self::ERREUR_CONNEXION_TPL, '');
184
						$e = sprintf(self::ERREUR_CONNEXION_TPL, '');
170
						trigger_error($e, E_USER_WARNING);
185
						trigger_error($e, E_USER_WARNING);
171
					}
186
					}
-
 
187
					$this->requeter("PRAGMA case_sensitive_like = false");
172
					break;
188
					break;
173
				default:
189
				default:
174
					$this->connexion = null;
190
					$this->connexion = null;
175
			}
191
			}
176
	
-
 
177
			if ($this->encodage != null) {
-
 
178
				$this->requete("SET names '".$this->encodage."'");
-
 
179
			}
-
 
180
		}
192
		}
181
	}
193
	}
182
	
194
 
183
	/**
195
	/**
184
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see requeter
196
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see requeter
185
	 */
197
	 */
186
	final protected function requete($requete) {
198
	final protected function requete($requete) {
187
		return $this->requeter($requete);
199
		return $this->requeter($requete);
188
	}
200
	}
189
	
201
 
190
	/**
202
	/**
191
	 * Execute une requête et retourne le résultat tel que renvoyé par l'abstraction courante.
203
	 * Execute une requête et retourne le résultat tel que renvoyé par l'abstraction courante.
192
	 *
204
	 *
193
	 * @param string la requête à effectuer
205
	 * @param string la requête à effectuer
194
	 * @return mixed un objet contenant le résultat de la requête
206
	 * @return mixed un objet contenant le résultat de la requête
Line 216... Line 228...
216
				$retour = $this->connexion->exec($requete);
228
				$retour = $this->connexion->exec($requete);
217
				break;
229
				break;
218
		}
230
		}
219
		return $retour;
231
		return $retour;
220
	}
232
	}
221
	
233
 
222
	/**
234
	/**
223
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see recuperer
235
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see recuperer
224
	 */
236
	 */
225
	final protected function requeteUn($requete, $mode = self::MODE_ASSOC) {
237
	final protected function requeteUn($requete, $mode = self::MODE_ASSOC) {
226
		return $this->recuperer($requete, $mode);
238
		return $this->recuperer($requete, $mode);
227
	}
239
	}
228
	
240
 
229
	/**
241
	/**
230
	 * Execute une requête et retourne le premier résultat sous forme de tableau (par défaut) ou d'objet.
242
	 * 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.
243
	 * 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
	 *
244
	 *
233
	 * @param string la requête à effectuer
245
	 * @param string la requête à effectuer
Line 262... Line 274...
262
				$retour = $this->connexion->querySingle($requete);
274
				$retour = $this->connexion->querySingle($requete);
263
				break;
275
				break;
264
		}
276
		}
265
		return $retour;
277
		return $retour;
266
	}
278
	}
267
	
279
 
268
	/**
280
	/**
269
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see recupererTous
281
	 * @deprecated changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see recupererTous
270
	 */
282
	 */
271
	final protected function requeteTous($requete, $mode = self::MODE_ASSOC) {
283
	final protected function requeteTous($requete, $mode = self::MODE_ASSOC) {
272
		return $this->recupererTous($requete, $mode);
284
		return $this->recupererTous($requete, $mode);
273
	}
285
	}
274
	
286
 
275
	/**
287
	/**
276
	 * Execute une requête et retourne un tableau de résultats. Un résultat peut être présentés sous forme 
288
	 * 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.
289
	 * 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 
290
	 * 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.
291
	 * aux noms des attributs de l'objet résultat.
280
	 *
292
	 *
281
	 * @param string la requête à effectuer
293
	 * @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.
294
	 * @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).
295
	 * @return array un tableau contenant les résultats sous forme d'objets ou de tableau (par défaut).
284
	 */
296
	 */
285
	public function recupererTous($requete, $mode = self::MODE_ASSOC) {
297
	public function recupererTous($requete, $mode = self::MODE_ASSOC) {
286
		$this->connecter();
298
		$this->connecter();
287
		
299
 
288
		$retour = null;
300
		$retour = null;
289
		switch ($this->abstraction) {
301
		switch ($this->abstraction) {
290
			case self::ABSTRACTION_PDO :
302
			case self::ABSTRACTION_PDO :
291
				try {
303
				try {
292
					$resultat = $this->connexion->query($requete);
304
					$resultat = $this->connexion->query($requete);
Line 357... Line 369...
357
	/**
369
	/**
358
	 * 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
370
	 * 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
359
	 * le cas de PDO, du driver utilisé. Les méthodes utilisées pour retourner l'identifiant peuvent avoir des comportements
371
	 * le cas de PDO, du driver utilisé. Les méthodes utilisées pour retourner l'identifiant peuvent avoir des comportements
360
	 * différent. Consulter la documentation PHP correspondant à l'abstraction choisie avant de l'utiliser :
372
	 * différent. Consulter la documentation PHP correspondant à l'abstraction choisie avant de l'utiliser :
361
	 * @link(http://fr.php.net/manual/fr/pdo.lastinsertid.php, PDO::lastInsertId([ string $name = NULL ]))
373
	 * @link(http://fr.php.net/manual/fr/pdo.lastinsertid.php, PDO::lastInsertId([ string $name = NULL ]))
362
	 * @link(http://php.net/manual/en/mysqli.insert-id.php, mysqli->insert_id()) 
374
	 * @link(http://php.net/manual/en/mysqli.insert-id.php, mysqli->insert_id())
363
	 * @link(http://fr.php.net/manual/fr/function.mysql-insert-id.php, mysql_insert_id())
375
	 * @link(http://fr.php.net/manual/fr/function.mysql-insert-id.php, mysql_insert_id())
364
	 * @link(http://fr.php.net/manual/fr/sqlite3.lastinsertrowid.php, SQLite3::lastInsertRowID()) 
376
	 * @link(http://fr.php.net/manual/fr/sqlite3.lastinsertrowid.php, SQLite3::lastInsertRowID())
365
	 * @param mixed un paramètre éventuel à transmettre (en fonction de l'abstraction de BDD utilisée).
377
	 * @param mixed un paramètre éventuel à transmettre (en fonction de l'abstraction de BDD utilisée).
366
	 * @return mixed le dernier identifiant de clé primaire ajouté dans la base de données (string ou int).
378
	 * @return mixed le dernier identifiant de clé primaire ajouté dans la base de données (string ou int).
367
	 */
379
	 */
368
	public function recupererIdDernierAjout($parametres = null) {
380
	public function recupererIdDernierAjout($parametres = null) {
369
		$this->connecter();
381
		$this->connecter();
Line 383... Line 395...
383
				$retour = $this->connexion->lastInsertRowID();
395
				$retour = $this->connexion->lastInsertRowID();
384
				break;
396
				break;
385
		}
397
		}
386
		return $retour;
398
		return $retour;
387
	}
399
	}
388
	
400
 
389
	/**
401
	/**
390
	 * Destructeur de classe, se contente de fermer explicitement la connexion à la base de donnée.
402
	 * Destructeur de classe, se contente de fermer explicitement la connexion à la base de donnée.
391
	 */
403
	 */
392
	public function __destruct() {
404
	public function __destruct() {
393
		if (isset($this->connexion)) {
405
		if (isset($this->connexion)) {
Line 396... Line 408...
396
					$this->connexion = null;
408
					$this->connexion = null;
397
					break;
409
					break;
398
				case self::ABSTRACTION_MYSQL :
410
				case self::ABSTRACTION_MYSQL :
399
					if (isset($this->connexion)) {
411
					if (isset($this->connexion)) {
400
						return mysql_close($this->connexion);
412
						return mysql_close($this->connexion);
401
					}	
413
					}
402
					break;
414
					break;
403
				case self::ABSTRACTION_MYSQLI :
415
				case self::ABSTRACTION_MYSQLI :
404
					$this->connexion->close();
416
					$this->connexion->close();
405
					break;
417
					break;
406
				case self::ABSTRACTION_SQLITE3 :
418
				case self::ABSTRACTION_SQLITE3 :