Subversion Repositories Applications.framework

Rev

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