Subversion Repositories Applications.framework

Rev

Details | 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 
/**
219 jpm 4 
* Classe modèle, d'accés au données, elle ne devrait pas être appelée de l'extérieur.
5 
* Elle fait office d'abstraction légère de base de données en utilisant diverses possibilités
6 
* d'abstraction de base 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 
* Elle est abstraite et doit donc obligatoirement être étendue.
120 aurelien 9 
*
219 jpm 10 
* @category	php 5.2
11 
* @package		Framework
12 
* @author		Aurélien PERONNET <aurelien@tela-botanica.org>
13 
* @copyright	2009 Tela-Botanica
14 
* @license		http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
15 
* @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
16 
* @version		SVN: $Id: Modele.php 219 2010-11-10 13:27:48Z jpm $
17 
* @link		/doc/framework/
120 aurelien 18 
*
105 aurelien 19 
*/
5 aurelien 20 
abstract class Modele {
219 jpm 21 
	/** Constante stockant le squelette du message en cas d'erreur de requête sql. */
22 
	const ERREUR_REQUETE_TPL = 'Requête echec.\nFichier : %s.\nLigne : %s.\nMessage : %s.\nRequête : %s';
23 
 
24 
	/** Constante stockant le squelette du message en cas d'erreur de connexion à la base de données. */
25 
	const ERREUR_CONNEXION_TPL = 'Erreur de connexion à la base de données, vérifiez les paramètres du fichier de configuration.\nMessage : %S.';
26 
 
27 
	/** Constante stockant le squelette du message en cas d'erreur de sélection de la base de données. */
28 
	const ERREUR_CONNEXION_TPL = 'Erreur de sélection de la base de données, vérifiez les paramètres du fichier de configuration.\nMessage : %S.';
29 
 
30 
	/** Constante stockant le code pour l'abstraction de PDO. */
31 
	const ABSTRACTION_PDO = 'pdo';
32 
 
33 
	/** Constante stockant le code pour l'abstraction de mysql. */
34 
	const ABSTRACTION_MYSQL = 'mysql';
35 
 
36 
	/** Constante stockant le code pour l'abstraction de mysqli. */
37 
	const ABSTRACTION_MYSQLI = 'mysqli';
38 
 
39 
	/** Constante stockant le code pour l'abstraction de SQLite3. */
40 
	const ABSTRACTION_SQLITE3 = 'sqlite3';
41 
 
42 
	/** Constante stockant le code pour le mode tableau associatif des résultats des requêtes. */
43 
	const MODE_ASSOC = 'ASSOC';
44 
 
45 
	/** Constante stockant le code pour le mode objet des résultats des requêtes. */
46 
	const MODE_OBJET = 'OBJECT';
47 
 
48 
	/** Mode de fetch associatif */
133 aurelien 49 
	private $ASSOC = '';
219 jpm 50 
 
51 
	/** Mode de fetch objet */
133 aurelien 52 
	private $OBJECT = '';
53 
 
219 jpm 54 
	/** abstraction de base de données utilisée */
133 aurelien 55 
	private $abstraction;
219 jpm 56 
 
57 
	/** DSN pour accéder à la base de données */
5 aurelien 58 
	private $dsn;
219 jpm 59 
 
60 
	/** Type de base de données (mysql, mysqli, etc ...) */
5 aurelien 61 
	private $type;
219 jpm 62 
 
63 
	/** Hote herbergeant la base de données */
5 aurelien 64 
	private $hote;
219 jpm 65 
 
66 
	/** Nom de la base de données à laquelle le modèle doit se connecter */
5 aurelien 67 
	private $bdd_nom;
219 jpm 68 
 
69 
	/** Nom d'utilisateur */
5 aurelien 70 
	private $utilisateur;
219 jpm 71 
 
72 
	/** Mot de passe */
5 aurelien 73 
	private $pass;
120 aurelien 74 
 
219 jpm 75 
	/** Encodage de la base de données */
120 aurelien 76 
	 private $encodage = null;
219 jpm 77 
 
78 
	/** Connexion à la base de données */
5 aurelien 79 
	private $connexion = null;
80 
 
81 
	/**
105 aurelien 82 
	 * Constructeur par défaut, appelé à l'initialisation.
5 aurelien 83 
	 */
145 jpm 84 
	public function __construct() {
133 aurelien 85 
		$this->abstraction = strtolower(Config::get('bdd_abstraction'));
120 aurelien 86 
		$this->type = Config::get('bdd_protocole');
87 
		$this->hote = Config::get('bdd_serveur');
88 
		$this->bdd_nom = Config::get('bdd_nom');
89 
		$this->utilisateur = Config::get('bdd_utilisateur');
90 
		$this->pass = Config::get('bdd_mot_de_passe');
91 
		$this->encodage = Config::get('bdd_encodage');
92 
 
93 
		$this->dsn = $this->type.':dbname='.$this->bdd_nom.';host='.$this->hote;
133 aurelien 94 
		$this->initialiserProtocole();
120 aurelien 95 
	}
96 
 
97 
	/**
133 aurelien 98 
	 * Connection à la base de données en utilisant les informations fournies par
99 
	 * le fichier de configuration.
100 
	 * private et final car n'a pas vocation a être appelée par l'utilisateur.
101 
	 *
102 
	 * @throws Exception une exception dans le cas ou là connexion échoue
103 
	 */
104 
	final private function connecter() {
105 
		switch ($this->abstraction) {
219 jpm 106 
			case self::ABSTRACTION_PDO :
107 
				try {
108 
					$this->connexion = new PDO($this->dsn, $this->utilisateur, $this->pass);
109 
				} catch (PDOException $e) {
110 
					$e = sprintf(self::ERREUR_CONNEXION_TPL, $e->getMessage());
111 
					trigger_error($e, E_USER_WARNING);
112 
				}
113 
				break;
114 
			case self::ABSTRACTION_MYSQL :
115 
				$this->connexion = mysql_connect($this->hote, $this->utilisateur, $this->pass);
116 
				if ($this->connexion !== false) {
117 
					$selection = mysql_select_db($this->bdd_nom, $this->connexion);
118 
					if ($selection === false) {
119 
						$e = sprintf(self::ERREUR_SELECTION_BDD_TPL, mysql_error());
120 
						trigger_error($e, E_USER_WARNING);
121 
					}
133 aurelien 122 
				} else {
219 jpm 123 
					$e = sprintf(self::ERREUR_CONNEXION_TPL, mysql_error());
124 
					trigger_error($e, E_USER_WARNING);
133 aurelien 125 
				}
219 jpm 126 
				break;
127 
			case self::ABSTRACTION_MYSQLI :
128 
				$this->connexion = @new mysqli($this->hote, $this->utilisateur, $this->pass, $this->bdd_nom);
129 
				if ($this->connexion->connect_errno) {
130 
					$e = sprintf(self::ERREUR_CONNEXION_TPL, $this->connexion->connect_error);
131 
					trigger_error($e, E_USER_WARNING);
133 aurelien 132 
				}
219 jpm 133 
				break;
134 
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 135 
				// cas particulier de sqllite, on considère que le nom de la base de données correspond au fichier à ouvrir
136 
				$this->connexion = new SQLite3($this->bdd_nom);
140 jpm 137 
				if (!$this->connexion) {
219 jpm 138 
					$e = sprintf(self::ERREUR_CONNEXION_TPL, '');
139 
					trigger_error($e, E_USER_WARNING);
133 aurelien 140 
				}
219 jpm 141 
				break;
133 aurelien 142 
			default:
143 
				$this->connexion = null;
144 
		}
145 
 
140 jpm 146 
		if ($this->encodage != null) {
133 aurelien 147 
			$this->requete("SET names '".$this->encodage."'");
148 
		}
149 
	}
150 
 
151 
	/**
140 jpm 152 
	 * Fonction qui appelle la bonne fonction pour executer une requête suivant le type de bdd.
120 aurelien 153 
	 *
154 
	 * @param string la requete à effectuer
155 
	 * @return PDOStatement un objet contenant le résultat de la requête
156 
	 */
157 
	final protected function requete($requete) {
158 
		if ($this->connexion == null) {
159 
			$this->connecter();
160 
		}
133 aurelien 161 
		$retour = null;
219 jpm 162 
 
133 aurelien 163 
		switch ($this->abstraction) {
219 jpm 164 
			case self::ABSTRACTION_PDO :
165 
				try {
166 
					$retour = $this->connexion->query($requete);
167 
				} catch (PDOException $e) {
168 
					$m = sprintf(self::ERREUR_REQUETE_TPL, $e->getFile(), $e->getLine(), $e->getMessage(), $requete);
169 
					trigger_error($m, E_USER_WARNING);
170 
				}
140 jpm 171 
				break;
219 jpm 172 
			case self::ABSTRACTION_MYSQL :
173 
				$retour = mysql_query($requete, $this->connexion);
140 jpm 174 
				break;
219 jpm 175 
			case self::ABSTRACTION_MYSQLI :
133 aurelien 176 
				$retour = $this->connexion->query($requete);
140 jpm 177 
				break;
219 jpm 178 
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 179 
				$retour = $this->connexion->exec($requete);
140 jpm 180 
				break;
133 aurelien 181 
		}
182 
		return $retour;
120 aurelien 183 
	}
184 
 
219 jpm 185 
	final protected function requeteUn($requete, $mode = self::MODE_ASSOC) {
133 aurelien 186 
		if ($this->connexion == null) {
187 
			$this->connecter();
188 
		}
189 
 
190 
		$retour = null;
191 
		switch ($this->abstraction) {
219 jpm 192 
			case self::ABSTRACTION_PDO :
173 aurelien 193 
				try {
194 
					$res_req = $this->connexion->query($requete);
195 
					$retour =$res_req->fetch($this->$mode);
196 
				} catch (PDOException $e) {
219 jpm 197 
					$m = sprintf(self::ERREUR_REQUETE_TPL, $e->getFile(), $e->getLine(), $e->getMessage(), $requete);
198 
					trigger_error($m, E_USER_WARNING);
173 aurelien 199 
				}
140 jpm 200 
				break;
219 jpm 201 
			case self::ABSTRACTION_MYSQL :
133 aurelien 202 
				$res = mysql_query($requete,$this->connexion);
203 
				$fonction_fetch = $this->$mode;
204 
				$retour = $fonction_fetch($res);
140 jpm 205 
				break;
219 jpm 206 
			case self::ABSTRACTION_MYSQLI :
133 aurelien 207 
				$res = $this->connexion->query($requete);
208 
				$fonction_fetch = $this->$mode;
209 
				$retour = $res->$fonction_fetch();
140 jpm 210 
				break;
219 jpm 211 
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 212 
				$retour = $this->connexion->querySingle($requete);
140 jpm 213 
				break;
133 aurelien 214 
		}
215 
 
216 
		return $retour;
120 aurelien 217 
	}
218 
 
133 aurelien 219 
 
219 jpm 220 
	final protected function requeteTous($requete, $mode = self::MODE_ASSOC) {
133 aurelien 221 
		if ($this->connexion == null) {
222 
			$this->connecter();
223 
		}
224 
 
225 
		$retour = null;
226 
 
227 
		switch ($this->abstraction) {
219 jpm 228 
			case self::ABSTRACTION_PDO :
143 jpm 229 
				try {
230 
					$res_req = $this->connexion->query($requete);
231 
					if ($res_req !== false) {
232 
						$retour = $res_req->fetchAll($this->$mode);
233 
					} else {
234 
						$retour = false;
235 
					}
236 
				} catch (PDOException $e) {
219 jpm 237 
					$m = sprintf(self::ERREUR_REQUETE_TPL, $e->getFile(), $e->getLine(), $e->getMessage(), $requete);
238 
					trigger_error($m, E_USER_WARNING);
140 jpm 239 
				}
240 
				break;
219 jpm 241 
			case self::ABSTRACTION_MYSQL :
140 jpm 242 
				$res = mysql_query($requete, $this->connexion);
133 aurelien 243 
				$fonction_fetch = $this->$mode;
140 jpm 244 
				while ($ligne = $fonction_fetch($res)) {
133 aurelien 245 
					$retour[] = $ligne;
246 
				}
140 jpm 247 
				break;
219 jpm 248 
			case self::ABSTRACTION_MYSQLI :
133 aurelien 249 
				$res = $this->connexion->query($requete);
250 
				$function_fetch = $this->$mode;
140 jpm 251 
				while ($ligne = $res->$function_fetch()) {
133 aurelien 252 
					$retour[] = $ligne;
253 
				}
140 jpm 254 
				break;
219 jpm 255 
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 256 
				$res = $this->connexion->query($requete);
140 jpm 257 
				while ($ligne = $res->fetch_array($this->ASSOC)) {
219 jpm 258 
					if ($mode == self::MODE_OBJET) {
259 
						// Cas particulier de sqllite qui n'a pas de fonction fetch_object
133 aurelien 260 
						$ligneObjet = new stdClass();
140 jpm 261 
						foreach ($ligne as $colonne => $valeur) {
133 aurelien 262 
							$ligneObjet->$colonne = $valeur;
263 
						}
219 jpm 264 
						$ligne = $ligneObjet;
133 aurelien 265 
					}
219 jpm 266 
					$retour[] = $ligne;
133 aurelien 267 
				}
140 jpm 268 
				break;
133 aurelien 269 
		}
270 
 
271 
		return $retour;
272 
	}
273 
 
120 aurelien 274 
	/**
219 jpm 275 
	 * Protège une chaine de caractères avant l'insertion dans la base de données.
120 aurelien 276 
	 */
277 
	final protected function proteger($chaine) {
278 
		if ($this->connexion == null) {
279 
			$this->connecter();
119 jp_milcent 280 
		}
133 aurelien 281 
 
282 
		$retour = $chaine;
283 
 
284 
		switch ($this->abstraction) {
219 jpm 285 
			case self::ABSTRACTION_PDO :
133 aurelien 286 
				$retour = $this->connexion->quote($chaine);
140 jpm 287 
				break;
219 jpm 288 
			case self::ABSTRACTION_MYSQL :
133 aurelien 289 
				$retour = '"'.mysql_real_escape_string($chaine, $this->connexion).'"';
140 jpm 290 
				break;
219 jpm 291 
			case self::ABSTRACTION_MYSQLI :
133 aurelien 292 
				$retour = '"'.$this->connexion->real_escape_string($chaine).'"';
140 jpm 293 
				break;
219 jpm 294 
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 295 
				$retour = $this->connexion->escapeString($chaine);
140 jpm 296 
				break;
133 aurelien 297 
		}
298 
 
299 
		return $retour;
120 aurelien 300 
	}
301 
 
302 
	/**
219 jpm 303 
	 * Initialise les constantes de classe à leur bonne valeur et déclenche une erreur si le protocole n'est pas bien défini.
133 aurelien 304 
	 */
305 
	final public function initialiserProtocole() {
306 
		switch ($this->abstraction) {
219 jpm 307 
			case self::ABSTRACTION_PDO :
133 aurelien 308 
				$this->ASSOC = PDO::FETCH_ASSOC;
309 
				$this->OBJECT = PDO::FETCH_CLASS;
140 jpm 310 
				break;
219 jpm 311 
			case self::ABSTRACTION_MYSQL :
133 aurelien 312 
				$this->ASSOC = 'mysql_fetch_assoc';
313 
				$this->OBJECT = 'mysql_fetch_object';
140 jpm 314 
				break;
219 jpm 315 
			case self::ABSTRACTION_MYSQLI :
133 aurelien 316 
				$this->ASSOC = 'fetch_assoc';
317 
				$this->OBJECT = 'fetch_object';
140 jpm 318 
				break;
219 jpm 319 
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 320 
				$this->ASSOC = 'SQLITE3_ASSOC';
321 
				$this->OBJECT = 'SQLITE3_OBJECT';
140 jpm 322 
				break;
133 aurelien 323 
			default:
219 jpm 324 
				$m = "Erreur : l'abstraction '{$this->abstraction}' n'est pas prise en charge";
325 
				trigger_error($m, E_USER_WARNING);
133 aurelien 326 
		}
327 
	}
328 
 
329 
	/**
219 jpm 330 
	 * Destructeur de classe, se contente de fermer explicitement la connexion à la base de donnée.
120 aurelien 331 
	 */
332 
	final public function __destruct() {
133 aurelien 333 
		switch ($this->abstraction) {
219 jpm 334 
			case self::ABSTRACTION_PDO :
133 aurelien 335 
				$this->connexion = null;
140 jpm 336 
				break;
219 jpm 337 
			case self::ABSTRACTION_MYSQL :
133 aurelien 338 
				return mysql_close($this->connexion);
140 jpm 339 
				break;
219 jpm 340 
			case self::ABSTRACTION_MYSQLI :
133 aurelien 341 
				$this->connexion->close();
140 jpm 342 
				break;
219 jpm 343 
			case self::ABSTRACTION_SQLITE3 :
133 aurelien 344 
				$this->connexion->close();
140 jpm 345 
				break;
120 aurelien 346 
		}
347 
	}
5 aurelien 348 
}
349 
?>