1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
|
<?php
/**
*
* Cette class est abstraite car elle ne permet
* pas d'elle même la création d'une instance de modèle.
* On verra plus loin de quoi elle a besoin pour fonctionner
* correctement.
*
* Dans cette classe, on part du principe que les tables en
* base de données qui porteront les valeur possède une clé
* primaire nommée 'id'. C'est nécéssaire pour se simplifier
* la vie des deux cotés et c'est une recommandation de ma
* part.
*
*/
abstract class Model {
/**
* On va stocker dans cette variable un tableau
* qui caractérise les données de notre objet.
* En fait, ce seront les données renvoyées par le
* 'select'.
*/
protected $_data;
/**
* On va conserver les PDOStatement qui nous serviront
* à effectuer les opérations CRUD (Create, Retrieve,
* Update, Delete) qui nous permettront de manager
* conjointement les données de la l'objet et leur
* valeurs en base de données.
* Cette propriété doit rester statique car elle
* est dépendante d'une classe modèle donnée et non
* pas d'un objet, il est donc innutile de délcarer
* 4 PDOStatement par instance car chaque instance à
* le même job.
* Les données renvoyées par ces statements sont en
* revanche dépendantes de l'instance en cours donc
* elles sont dans la propriété d'instance _data.
*/
protected static $_statements;
/**
* On conserve ici un flag qui nous indique si les
* propriété statique (de classe si tu préfères) ont
* été correctement initialisées.
*/
protected static $_initialized;
/**
* On choisit de garder le constructeur protéger et
* de ne donner un accès aux instances qu'au travers
* des méthodes 'find' et 'create' (voir plus bas).
* ça signifie entre autre que faire un new sur une
* classe dérivée de modèle échoura systématiquement.
*
* Ce constructeur par défaut mets à jour
* les données de l'objet (_data) avec le tableau
* qu'il reçoit en paramètre.
*/
protected function __construct ($data) {
$this->_data = $data;
}
/**
* On définit ici une méthode magique pour accéder
* directement au contenu de _data.
* ça permet de faire
* $instance_modele->nom_de_champ
*/
public function __get ($key) {
if (isset($this->_data[$key])) {
return $this->_data[$key];
}
else {
throw new OutOfRangeException("Cannot find $key in model's data");
}
}
/**
* On définit ici une méthode magique
* pour éditer le contenu de _data.
* Ainsi, à chaque edition de l'objet
* de travail, les champs correspondant
* en database dont mis à jour instantanment.
* On appelle cela 'ActiveRecord' ou les objets
* et leurs données en DB sont mis à jour ensemble.
*/
public function __set ($key, $value) {
/**
* on interdit formellement de changer
* l'id utilisé dans la base de données !!!
* Sinon ça pourrait découpler l'objet et
* sa représentation mysql ce qui violerait
* le design pattern active record et créerait
* des doublons partout.
*/
if ($key == 'id') {
throw new LogicException('Cannot change id in Model instances');
}
/**
* Si la clé existe
*/
if (isset($this->_data[$key])) {
/**
* on la modifie
*/
$this->_data[$key] = (string)$value;
/**
* et on met à jour dans la base de données
*/
$this->update();
}
else {
throw new OutOfRangeException("Cannot find $key in model's data");
}
}
/**
* Dans cette méthode, on va initialiser les
* PDOStatement nécéssaire à toutes les operations
* CRUD. Elle reste protégé pour que les classes
* filles puissent surcharger son comportement
* (en fait elles DOIVENT le surcharger) et que
* de l'exterieur de la classe on ne puiss pas
* l'appeller.
* Note: cette méthode devrait porter un paramètre
* $statements mais elle n'en porte aucun.
* On procède de cette manière pour que les classes
* filles puisent porter une signature sans paramètres
* qui sera appellée par les méthodes statiques
* find et create qui ne doivent pas lui passer
* de paramètres.
* On utilisera à cet effet le late static binding
* dans les méthodes find et create qui permettront
* d'appeller _init dans la fille qui se chargera
* de définir les statement puis les passera à
* _ini de la mère (Model).
*/
protected static function _init () {
if (func_num_args() == 0) throw BadMethodCallException(__METHOD__ . ' expects at least 1 parameter');
/**
* les statements sont dans le premier paramètre
*/
$statements = func_get_arg(0);
/**
* On verifie qu'on a tout ce qu'il nous faut
*/
if (isset($statements['create'], $statements['retrieve'], $statements['update'], $statements['delete'])) {
/**
* on créé tous les statements CRUD
*/
static::$_statements['create'] = Database::prepare($statements['create']);
static::$_statements['retrieve'] = Database::prepare($statements['retrieve']);
static::$_statements['update'] = Database::prepare($statements['update']);
static::$_statements['delete'] = Database::prepare($statements['delete']);
return static::$_initialized = true;
}
else
throw new InvalidArgumentException("Statements are missing");
}
/**
* Cette méthode est, avec create, le seul moyen
* d'instancier des objets Model.
*/
public static function find ($id) {
/**
* Si la classe (attention, pas l'instance! )
* n'est pas initialisée, on appelle _init dans
* le contexte de la fille de Model.
* On utilise pour ça le mot clé static.
* CF late static binding.
*/
if (!static::$_initialized && !static::_init()) return false;
/**
* on execute le statement de récupération des données
*/
if (static::$_statements['retrieve']->execute(array(':id' => $id))) {
/**
* on vérifie qu'on trouve bien quelque chose
*/
if (static::$_statements['retrieve']->rowCount()) {
/**
* et on appelle le constructeur DE LA FILLE toujours avec
* le mot clé static en lui passant le retour de la requête SQL.
* voir le constructeur.
* Et on renvoie l'instance ainsi crée.
*/
return new static (static::$_statements['retrieve']->fetch(PDO::FETCH_ASSOC));
}
}
/**
* on s'est gaufré, il n'y a pas d'objet
*/
return false;
}
/**
* Create est avec find la seule méthode permettant de
* réccupérer des instances, elle attends en paramètres
* un tableau associatif clé valeur dont les clés
* correspondent aux éléments présents dans la requête
* préparée.
*/
public static function create ($values) {
/**
* Toujours pareil, on tente d'initialiser si ce n'est pas
* défjà fait
*/
if (!static::$_initialized && !static::_init()) return false;
/**
* On tente l'insertion
*/
if (static::$_statements['create']->execute($values)) {
/**
* Si c'est ok, on réccupère l'id inséré
*/
$id = Database::lastInsertId();
/**
* et on renvoie l'objet en passant par find
* (pattern DRY: Don't Repeat Yourself)
*/
return static::find($id);
}
else {
return false;
}
}
/**
* Contrairement à find et create qui
* sont des méthodes de classe, delete
* est une méthode d'instance car elle
* a besoin que l'objet existe pour
* le supprimer (logique).
* On ne fait donc qu'appelle le
* statement de suppression avec l'id
* présent dans les données de l'objet
*/
public function delete () {
return static::$_statements['delete']->execute(array(':id' => $this->_data['id']));
}
/**
* Contrairement à find et create,
* update est une méthode d'instance
* car elle a besoin des données de l'objet
* pour le mettre à jour en base (logique).
* Comme tu le vois dans __set, cette
* méthode est appellée à chaque modification
* de ton objet.
* On ne fais donc qu'appeller le statement
* d'update pour mettre les donénes de
* l'objet à jour dans la db.
*/
protected function update () {
return static::$_statements['update']->execute($this->_data);
}
} |
Partager