Professional Documents
Culture Documents
www.siteduzero.com
2/333
Sommaire
Sommaire ........................................................................................................................................... 2 Lire aussi ............................................................................................................................................ 5 Programmez en orient objet en PHP ............................................................................................... 7
Ce qui doit tre acquis ....................................................................................................................................................... 7
L'hritage ......................................................................................................................................................................... 72
Notion d'hritage ....................................................................................................................................................................................................... Dfinition ................................................................................................................................................................................................................... Procder un hritage .............................................................................................................................................................................................. Surcharger les mthodes .......................................................................................................................................................................................... Hritez l'infini ! ........................................................................................................................................................................................................ Un nouveau type de visibilit : protected .................................................................................................................................................................. 73 73 74 75 76 78
www.siteduzero.com
Sommaire
3/333
79 79 81 82 85 89 90
Imposer des contraintes ............................................................................................................................................................................................ Abstraction ................................................................................................................................................................................................................ Finalisation ................................................................................................................................................................................................................ Rsolution statique la vole ................................................................................................................................................................................... Cas complexes .......................................................................................................................................................................................................... Utilisation de static:: dans un contexte non statique ................................................................................................................................................. En rsum .................................................................................................................................................................................................................
www.siteduzero.com
Sommaire
4/333
167 167 168 169 170 170 171 172 172 173 174 174 175 176 177 178 179 180
Rcupration d'attribut d'une classe ....................................................................................................................................................................... Le nom et la valeur des attributs ............................................................................................................................................................................. Porte de l'attribut ................................................................................................................................................................................................... Les attributs statiques ............................................................................................................................................................................................. Obtenir des informations sur les mthodes de ses classes .................................................................................................................................... Cration d'une instance de ReflectionMethod ......................................................................................................................................................... Publique, protge ou prive ? ............................................................................................................................................................................... Abstraite ? Finale ? ................................................................................................................................................................................................. Constructeur ? Destructeur ? .................................................................................................................................................................................. Appeler la mthode sur un objet ............................................................................................................................................................................. Utiliser des annotations ........................................................................................................................................................................................... Prsentation d'addendum ....................................................................................................................................................................................... Rcuprer une annotation ....................................................................................................................................................................................... Savoir si une classe possde telle annotation ........................................................................................................................................................ Une annotation multiples valeurs ......................................................................................................................................................................... Des annotations pour les attributs et mthodes ...................................................................................................................................................... Contraindre une annotation une cible prcise ...................................................................................................................................................... En rsum ...............................................................................................................................................................................................................
www.siteduzero.com
Sommaire
5/333
243 243 243 244 246 247 248 248 250 254 254 255 256 258 260 260 261 262 263 263 264 264 265 265 266
L'application ............................................................................................................................................................................................................ L'application ............................................................................................................................................................................................................ La requte du client ................................................................................................................................................................................................. La rponse envoye au client ................................................................................................................................................................................. Retour sur notre application .................................................................................................................................................................................... Les composants de l'application ............................................................................................................................................................................. Le routeur ................................................................................................................................................................................................................ Rflchissons, schmatisons .................................................................................................................................................................................. Codons .................................................................................................................................................................................................................... Le back controller .................................................................................................................................................................................................... Rflchissons, schmatisons .................................................................................................................................................................................. Codons .................................................................................................................................................................................................................... Accder aux managers depuis le contrleur ........................................................................................................................................................... propos des managers .......................................................................................................................................................................................... La page ................................................................................................................................................................................................................... Rflchissons, schmatisons .................................................................................................................................................................................. Codons .................................................................................................................................................................................................................... Retour sur la classe BackController ........................................................................................................................................................................ Retour sur la mthode HTTPResponse::redirect404() ............................................................................................................................................ Bonus : l'utilisateur .................................................................................................................................................................................................. Rflchissons, schmatisons .................................................................................................................................................................................. Codons .................................................................................................................................................................................................................... Bonus 2 : la configuration ........................................................................................................................................................................................ Rflchissons, schmatisons .................................................................................................................................................................................. Codons ....................................................................................................................................................................................................................
www.siteduzero.com
Lire aussi
6/333
instanceof et l'hritage ............................................................................................................................................................................................ 330 instanceof et les interfaces ...................................................................................................................................................................................... 330 En rsum ............................................................................................................................................................................................................... 332
www.siteduzero.com
Lire aussi
7/333
Par
13 517 visites depuis 7 jours, class 20/799 Bienvenue dans ce tutoriel sur la programmation oriente objet (souvent abrg par ses initiales POO ) en PHP. Ici, vous allez dcouvrir un nouveau moyen de penser votre code, un nouveau moyen de le concevoir. V ous allez le reprsenter de faon orient objet , un moyen de conception invent dans les annes 1970 et qui prend de plus en plus de place aujourd'hui. La principale raison de ce succs est due de nombreux avantages apports par ce paradigme, comme une organisation plus cohrente de vos projets, une maintenance plus facile et une distribution de votre code plus aise. Cependant, avant de vous lancer dans ce (trs) vaste domaine, vous devez avoir quelques connaissances au pralable.
www.siteduzero.com
8/333
Introduction la POO
Alors a y est, vous avez dcid de vous lancer dans la POO en PHP ? Sage dcision ! Nous allons donc plonger dans ce vaste domaine par une introduction cette nouvelle faon de penser : qu'est-ce que la POO ? En quoi a consiste ? En quoi est-ce si diffrent de la mthode que vous employez pour dvelopper votre site web ? Tant de questions auxquelles je vais rpondre. Cependant, puisque je sais que vous avez hte de commencer, nous allons entamer srieusement les choses en crant notre premire classe ds la fin de ce chapitre. V ous commencerez ainsi vos premiers pas dans la POO en PHP !
www.siteduzero.com
9/333
Une classe est une entit regroupant des variables et des fonctions. Chacune de ces fonctions aura accs aux variables de cette entit. Dans le cas du personnage, nous aurons une fonction frapper(). Cette fonction devra simplement modifier la variable $degats du personnage en fonction de la variable $force. Une classe est donc un regroupement logique de variables et fonctions que tout objet issu de cette classe possdera.
V ous voyez donc les variables et fonctions stockes dans la classe Personnage. Sachez qu'en ralit, on ne les appelle pas comme a : il s'agit d'attributs (ou proprits) et de mthodes . Un attribut dsigne une variable et une mthode dsigne une fonction. Ainsi, tout objet Personnage aura ces attributs et mthodes. On pourra modifier ces attributs et invoquer ces mthodes sur notre objet afin de modifier ses caractristiques ou son comportement.
Le principe d'encapsulation
www.siteduzero.com
10/333
L'un des gros avantages de la POO est que l'on peut masquer le code l'utilisateur (l'utilisateur est ici celui qui se servira de la classe, pas celui qui chargera la page depuis son navigateur). Le concepteur de la classe a englob dans celle-ci un code qui peut tre assez complexe et il est donc inutile voire dangereux de laisser l'utilisateur manipuler ces objets sans aucune restriction. Ainsi, il est important d'interdire l'utilisateur de modifier directement les attributs d'un objet. Prenons l'exemple d'un avion o sont disponibles des centaines de boutons. Chacun de ces boutons constituent des actions que l'on peut effectuer sur l'avion. C'est l'interface de l'avion. Le pilote se moque de quoi est compos l'avion : son rle est de le piloter. Pour cela, il va se servir des boutons afin de manipuler les composants de l'avion. Le pilote ne doit pas se charger de modifier manuellement ces composants : il pourrait faire de grosses btises. Le principe est exactement le mme pour la POO : l'utilisateur de la classe doit se contenter d'invoquer les mthodes en ignorant les attributs. Comme le pilote de l'avion, il n'a pas les trifouiller. Pour instaurer une telle contrainte, on dit que les attributs sont privs . Pour l'instant, ceci peut sans doute vous paratre abstrait, mais nous y reviendrons. Bon, je pense que j'ai assez parl, commenons par crer notre premire classe !
Cette syntaxe est retenir absolument. Heureusement, elle est simple. Ce qu'on vient de faire est donc de crer le moule, le plan qui dfinira nos objets. On verra dans le prochain chapitre comment utiliser ce plan afin de crer un objet. Pour l'instant, contentons-nous de construire ce plan et de lui ajouter des fonctionnalits. La dclaration d'attributs dans une classe se fait en crivant le nom de l'attribut crer, prcd de sa visibilit.
Cration d'attributs
www.siteduzero.com
11/333
Pour dclarer des attributs, on va donc les crire entre les accolades, les uns la suite des autres, en faisant prcder leurs noms du mot-cl private, comme a : Code : PHP <?php class Personnage { private $_force; private $_localisation; private $_experience; private $_degats; } ?>
// // // //
V ous pouvez constater que chaque attribut est prcd d'un underscore ( _ ). Ceci est une notation qu'il est prfrable de respecter (il s'agit de la notation PEAR) qui dit que chaque nom d'lment priv (ici il s'agit d'attributs, mais nous verrons plus tard qu'il peut aussi s'agir de mthodes) doit tre prcd d'un underscore. V ous pouvez initialiser les attributs lorsque vous les dclarez (par exemple, leur mettre une valeur de 0 ou autre). Exemple : Code : PHP <?php class Personnage { private $_force = 50; dfaut 50. private $_localisation = 'Lyon'; Lyon. private $_experience = 1; 1. private $_degats = 0; } ?>
// La force du personnage, par // Sa localisation, par dfaut // Son exprience, par dfaut // Ses dgts, par dfaut 0.
La valeur que vous leur donnez par dfaut doit tre une expression constante. Par consquent, leur valeur ne peut tre issue d'un appel une fonction (private $_attribut = intval('azerty')), d'une opration (private $_attribut = 1 + 1), d'une concatnation (private $_attribut = 'Mon ' . 'super ' . 'attribut') ou d'une variable, superglobale ou non (private $_attribut = $_SERVER['REQUEST_URI']).
Cration de mthodes
Pour la dclaration de mthodes, il suffit de faire prcder le mot-cl function la visibilit de la mthode. Les types de visibilit des mthodes sont les mmes que les attributs. Les mthodes n'ont en gnral pas besoin d'tre masques l'utilisateur, vous les mettrez souvent en public ( moins que vous teniez absolument ce que l'utilisateur ne puisse pas appeler cette mthode, par exemple s'il s'agit d'une fonction qui simplifie certaines tches sur l'objet mais qui ne doit pas tre appele n'importe comment). Code : PHP <?php class Personnage { private $_force; // La force du personnage private $_localisation; // Sa localisation
www.siteduzero.com
12/333
public function deplacer() // Une mthode qui dplacera le personnage (modifiera sa localisation). { } public function frapper() // Une mthode qui frappera un personnage (suivant la force qu'il a). { } public function gagnerExperience() // Une mthode augmentant l'attribut $experience du personnage. { } ?> }
Et voil. De mme que l'underscore prcdant les noms d'lments privs, vous pouvez remarquer que le nom des classes commence par une majuscule. Il s'agit aussi du respect de la notation PEAR.
En rsum
Une classe, c'est un ensemble de variables et de fonctions (attributs et mthodes). Un objet, c'est une instance de la classe pour pouvoir l'utiliser. Tous vos attributs doivent tre privs. Pour les mthodes, peu importe leur visibilit. C'est ce qu'on appelle le principe d'encapsulation. On dclare une classe avec le mot-cl class suivi du nom de la classe, et enfin deux accolades ouvrantes et fermantes qui encercleront la liste des attributs et mthodes.
www.siteduzero.com
13/333
Utiliser la classe
Une classe, c'est bien beau mais, au mme titre qu'un plan de construction pour une maison, si on ne sait pas comment se servir de notre plan pour construire notre maison, cela ne sert rien ! Nous verrons donc ainsi comment se servir de notre classe, notre modle de base, afin de crer des objets et pouvoir s'en servir. Ce chapitre sera aussi l'occasion d'approfondir un peu le dveloppement de nos classes : actuellement, la classe que l'on a cre contient des mthodes vides, chose un peu inutile vous avouerez. Pas de panique, on va s'occuper de tout a !
Ainsi, $perso sera un objet de type Personnage. On dit que l'on instancie la classe Personnage, que l'on cre une instance de la classe Personnage.
La ligne 18 signifie donc va chercher l'objet $perso, et invoque la mthode parler() sur cet objet . Notez donc bien quelque part l'utilisation de cet oprateur : de manire gnrale, il sert accder un lment de la classe. Ici, on s'en est servi pour atteindre une mthode, mais nous verrons plus tard qu'il nous permettra aussi d'atteindre un attribut.
www.siteduzero.com
14/333
Ici, on essaye d'accder un attribut priv hors de la classe. Ceci est interdit, donc PHP lve une erreur. Dans notre exemple (qui essaye en vain d'augmenter de 1 l'exprience du personnage), il faudra demander la classe d'augmenter l'exprience. Pour cela, nous allons crire une mthode gagnerExperience() : Code : PHP <?php class Personnage { private $_experience; public function gagnerExperience() { // Cette mthode doit ajouter 1 l'exprience du personnage. }
Oui mais voil : comment accder l'attribut $_experience dans notre mthode ? C'est l qu'intervient la pseudo-variable $this. Dans notre script, $perso reprsente l'objet. Il est donc facile d'appeler une mthode partir de cette variable. Mais dans notre mthode, nous n'avons pas cette variable pour accder notre attribut $_experience pour le modifier ! Du moins, c'est ce que vous croyez. En fait, un paramtre reprsentant l'objet est pass implicitement chaque mthode de la classe. Regardez plutt cet exemple : Code : PHP <?php class Personnage { private $_experience = 50;
www.siteduzero.com
15/333
Commentons la ligne 8. V ous avez sans doute reconnu la structure echo ayant pour rle d'afficher une valeur. Ensuite, vous reconnaissez la variable $this dont je vous ai parl : elle reprsente l'objet que nous sommes en train d'utiliser. Ainsi, dans ce script, les variables $this et $perso reprsentent le mme objet . L'instruction surligne veut donc dire : Affiche-moi cette valeur : dans l'objet utilis (donc $perso), donne-moi la valeur de l'attribut $_experience. Ainsi, je vais vous demander d'crire la mthode gagnerExperience(). Cette mthode devra ajouter 1 l'attribut $_experience. Je suis sr que vous pouvez y arriver ! V oici la correction : Code : PHP <?php class Personnage { private $_experience = 50; public function afficherExperience() { echo $this->_experience; } public function gagnerExperience() { // On ajoute 1 notre attribut $_experience. $this->_experience = $this->_experience + 1; }
$perso = new Personnage(); $perso->gagnerExperience(); // On gagne de l'exprience. $perso->afficherExperience(); // On affiche la nouvelle valeur de l'attribut.
www.siteduzero.com
16/333
Commenons par crire notre mthode frapper(). Cette mthode doit accepter un argument : le personnage frapper. La mthode aura juste pour rle d'augmenter les dgts du personnage pass en paramtre. Pour vous aider visualiser le contenu de la mthode, imaginez votre code manipulant des objets. Il doit ressembler ceci : Code : PHP <?php // On cre deux personnages $perso1 = new Personnage(); $perso2 = new Personnage(); // Ensuite, on veut que le personnage n1 frappe le personnage n2. $perso1->frapper($perso2);
Pour rsumer : la mthode frapper() demande un argument : le personnage frapper ; cette mthode augmente les dgts du personnage frapper en fonction de la force du personnage qui frappe.
On pourrait donc imaginer une classe ressemblant ceci : Code : PHP <?php class Personnage { private $_degats; // Les dgts du personnage. private $_experience; // L'exprience du personnage. private $_force; // La force du personnage (plus elle est grande, plus l'attaque est puissante). public function frapper($persoAFrapper) { $persoAFrapper->_degats += $this->_force; } public function gagnerExperience() { // On ajoute 1 notre attribut $_experience. $this->_experience = $this->_experience + 1; }
Commentons ensemble le contenu de cette mthode frapper(). Celle-ci comporte une instruction compose de deux parties : 1. La premire consiste dire PHP que l'on veut assigner une nouvelle valeur l'attribut $_degats du personnage frapper. 2. La seconde partie consiste donner PHP la valeur que l'on veut assigner. Ici, nous voyons que cette valeur est atteinte par $this->_force.
www.siteduzero.com
17/333
Maintenant, grosse question : la variable $this fait-elle rfrence au personnage qui frappe ou au personnage frapp ? Pour rpondre cette question, il faut savoir sur quel objet est appele la mthode. En effet, souvenez-vous que $this est une variable reprsentant l'objet partir duquel on a appel la mthode. Dans notre cas, on a appel la mthode frapper() partir du personnage qui frappe, donc $this reprsente le personnage qui frappe. L'instruction contenue dans la mthode signifie donc : Ajoute la valeur de la force du personnage qui frappe l'attribut $_degats du personnage frapp. Maintenant, nous pouvons crer une sorte de petite mise en scne qui fait interagir nos personnages. Par exemple, nous pouvons crer un script qui fait combattre les personnages. Le personnage 1 frapperait le personnage 2 puis gagnerait de l'exprience, puis le personnage 2 frapperait le personnage 1 et gagnerait de l'exprience. Procdez tape par tape : crez deux personnages ; faites frapper le personnage 1 ; faites gagner de l'exprience au personnage 1 ; faites frapper le personnage 2 ; faites gagner de l'exprience au personnage 2. Ce script n'est qu'une suite d'appels de mthodes. Chaque puce (sauf la premire) correspond l'appel d'une mthode, ce que vous savez faire. En conclusion, vous tes aptes crer ce petit script ! V oici la correction : Code : PHP <?php $perso1 = new Personnage(); // Un premier personnage $perso2 = new Personnage(); // Un second personnage $perso1->frapper($perso2); // $perso1 frappe $perso2 $perso1->gagnerExperience(); // $perso1 gagne de l'exprience $perso2->frapper($perso1); // $perso2 frappe $perso1 $perso2->gagnerExperience(); // $perso2 gagne de l'exprience ?>
Cependant, un petit problme se pose. Puisque, la base, les deux personnages ont le mme niveau de dgts, la mme exprience et la mme force, ils seront la fin toujours gaux. Pour pallier ce problme, il faudrait pouvoir assigner des valeurs spcifiques aux deux personnages, afin que le combat puisse les diffrencier. Or, vous ne pouvez pas accder aux attributs endehors de la classe ! Pour savoir comment rsoudre ce problme, je vais vous apprendre deux nouveaux mots : accesseur et mutateur. Mais avant, j'aimerais faire une petite parenthse.
Et l, qu'est-ce qui se passe ? Une erreur est gnre car, l'intrieur de la mthode frapper(), nous essayons d'appeler une mthode sur le paramtre qui n'est pas un objet. C'est comme si on avait fait a : Code : PHP
www.siteduzero.com
18/333
Ce qui n'a aucun sens. Il faut donc s'assurer que le paramtre pass est bien un personnage, sinon PHP arrte tout et n'excute pas la mthode. Pour cela, il suffit d'ajouter un seul mot : le nom de la classe dont le paramtre doit tre un objet. Dans notre cas, si le paramtre doit tre un objet de type Personnage, alors il faudra ajouter le mot-cl Personnage, juste avant le nom du paramtre, comme ceci : Code : PHP <?php class Personnage { // public function frapper(Personnage $persoAFrapper) { // }
Grce a, vous tes srs que la mthode frapper() ne sera excute que si le paramtre pass est de type Personnage, sinon PHP interrompt tout le script. V ous pouvez donc appeler les mthodes de l'objet sans crainte qu'un autre type de variable soit pass en paramtre. Le type de la variable spcifier doit obligatoirement tre un nom de classe ou alors un tableau. Si vous voulez exiger un tableau, faites prcder le nom du paramtre devant tre un tableau par le mot-cl array comme ceci : public function frapper(array $coups). V ous ne pouvez pas exiger autre chose : par exemple, il est impossible d'exiger un nombre entier ou une chane de caractres de cette faon.
www.siteduzero.com
19/333
www.siteduzero.com
20/333
// Mutateur charg de modifier l'attribut $_experience. public function setExperience($experience) { if (!is_int($experience)) // S'il ne s'agit pas d'un nombre entier. { trigger_error('L\'exprience d\'un personnage doit tre un nombre entier', E_USER_WARNING); return; } if ($experience > 100) // On vrifie bien qu'on ne souhaite pas assigner une valeur suprieure 100. { trigger_error('L\'exprience d\'un personnage ne peut dpasser 100', E_USER_WARNING); return; } } $this->_experience = $experience;
// Ceci est la mthode degats() : elle se charge de renvoyer le contenu de l'attribut $_degats. public function degats() { return $this->_degats; } // Ceci est la mthode force() : elle se charge de renvoyer le contenu de l'attribut $_force. public function force() { return $this->_force; } // Ceci est la mthode experience() : elle se charge de renvoyer le contenu de l'attribut $_experience. public function experience() { return $this->_experience; } }
V oil ce que j'avais dire concernant ces accesseurs et mutateurs. Retenez bien ces dfinitions, vous les trouverez dans la plupart des classes !
www.siteduzero.com
21/333
$perso1->frapper($perso2); // $perso1 frappe $perso2 $perso1->gagnerExperience(); // $perso1 gagne de l'exprience $perso2->frapper($perso1); // $perso2 frappe $perso1 $perso2->gagnerExperience(); // $perso2 gagne de l'exprience echo 'Le personnage 1 a ', $perso1->force(), ' de force, contrairement au personnage 2 qui a ', $perso2->force(), ' de force.<br />'; echo 'Le personnage 1 a ', $perso1->experience(), ' d\'exprience, contrairement au personnage 2 qui a ', $perso2->experience(), ' d\'exprience.<br />'; echo 'Le personnage 1 a ', $perso1->degats(), ' de dgts, contrairement au personnage 2 qui a ', $perso2->degats(), ' de dgts.<br />';
Comme nous l'avions dit, les valeurs finales des deux personnages sont identiques. Pour pallier ce problme, nous allons modifier, juste aprs la cration des personnages, la valeur de la force et de l'exprience des deux personnages. V ous pouvez par exemple favoriser un personnage en lui donnant une plus grande force et une plus grande exprience par rapport au deuxime. V oici la correction que je vous propose (peu importe les valeurs que vous avez choisies, l'essentiel est que vous ayez appel les bonnes mthodes) : Code : PHP <?php $perso1 = new Personnage(); // Un premier personnage $perso2 = new Personnage(); // Un second personnage $perso1->setForce(10); $perso1->setExperience(2); $perso2->setForce(90); $perso2->setExperience(58); $perso1->frapper($perso2); // $perso1 frappe $perso2 $perso1->gagnerExperience(); // $perso1 gagne de l'exprience $perso2->frapper($perso1); // $perso2 frappe $perso1 $perso2->gagnerExperience(); // $perso2 gagne de l'exprience echo 'Le personnage 1 a ', $perso1->force(), ' de force, contrairement au personnage 2 qui a ', $perso2->force(), ' de force.<br />'; echo 'Le personnage 1 a ', $perso1->experience(), ' d\'exprience, contrairement au personnage 2 qui a ', $perso2->experience(), ' d\'exprience.<br />'; echo 'Le personnage 1 a ', $perso1->degats(), ' de dgts, contrairement au personnage 2 qui a ', $perso2->degats(), ' de dgts.<br />';
www.siteduzero.com
22/333
Ce qui affichera :
le script Comme vous le voyez, la fin, les deux personnages n'ont plus les mmes caractristiques ! Pour bien tre sr que vous me suiviez toujours, je vous ai fait un schma rsumant le droulement du script.
Droulement du script
Le constructeur
V ous vous demandez peut-tre quoi servent les parenthses juste aprs Personnage lorsque vous crez un objet ? C'est ce que je vais vous expliquer juste aprs vous avoir expliqu ce qu'est un constructeur. Le constructeur est la mthode appele ds que vous crez l'objet avec la technique prsente ci-dessus. Cette mthode peut demander des paramtres, auquel cas nous devrons les placer entre les parenthses que vous voyez aprs le nom de la classe.
www.siteduzero.com
23/333
Effectuons un retour sur notre classe Personnage. Ajoutons-lui un constructeur. Ce dernier ne peut pas avoir n'importe quel nom (sinon, comment PHP sait quel est le constructeur ?). Il a tout simplement le nom suivant : __construct, avec deux underscores au dbut. Comme son nom l'indique, le constructeur sert construire l'objet. Ce que je veux dire par l, c'est que si des attributs doivent tre initialiss ou qu'une connexion la BDD doit tre faite, c'est par ici que a se passe. Comme dit plus haut, le constructeur est excut ds la cration de l'objet et par consquent, aucune valeur ne doit tre retourne, mme si a ne gnrera aucune erreur. Bien sr, et comme nous l'avons vu, une classe fonctionne trs bien sans constructeur, il n'est en rien obligatoire ! Si vous n'en spcifiez pas, cela revient au mme que si vous en aviez crit un vide (sans instruction l'intrieur). Code : PHP <?php class Personnage { private $_force; private $_localisation; private $_experience; private $_degats; public function __construct($force, $degats) // Constructeur demandant 2 paramtres { echo 'Voici le constructeur !'; // Message s'affichant une fois que tout objet est cr. $this->setForce($force); // Initialisation de la force. $this->setDegats($degats); // Initialisation des dgts. $this->_experience = 1; // Initialisation de l'exprience 1. } // Mutateur charg de modifier l'attribut $_force. public function setForce($force) { if (!is_int($force)) // S'il ne s'agit pas d'un nombre entier. { trigger_error('La force d\'un personnage doit tre un nombre entier', E_USER_WARNING); return; } if ($force > 100) // On vrifie bien qu'on ne souhaite pas assigner une valeur suprieure 100. { trigger_error('La force d\'un personnage ne peut dpasser 100', E_USER_WARNING); return; } } $this->_force = $force;
// Mutateur charg de modifier l'attribut $_degats. public function setDegats($degats) { if (!is_int($degats)) // S'il ne s'agit pas d'un nombre entier. { trigger_error('Le niveau de dgts d\'un personnage doit tre un nombre entier', E_USER_WARNING); return; } } $this->_degats = $degats;
} ?>
www.siteduzero.com
24/333
Ici, le constructeur demande la force et les dgts initiaux du personnage que l'on vient de crer. Il faudra donc lui spcifier ceci en paramtre : Code : PHP <?php $perso1 = new Personnage(60, 0); // 60 de force, 0 dgt $perso2 = new Personnage(100, 10); // 100 de force, 10 dgts ?>
le script Notez quelque chose d'important dans la classe : dans le constructeur, les valeurs sont initialises en appelant les mutateurs correspondant. En effet, si on assignait directement ces valeurs avec les arguments, le principe d'encapsulation ne serait plus respect et n'importe quel type de valeur pourrait tre assign ! Ne mettez jamais la mthode __construct avec le type de visibilit private car elle ne pourra jamais tre appele, vous ne pourrez donc pas instancier votre classe ! Cependant, sachez qu'il existe certains cas particuliers qui ncessitent le constructeur en priv, mais ce n'est pas pour tout de suite.
Notez que si la classe n'a pas implment de constructeur ou si le constructeur ne requiert aucun argument, alors les parenthses places aprs le nom de la classe lorsque vous l'instancierez sont inutiles. Ainsi, vous pourrez faire $classe = new MaClasse;. C'est d'ailleurs sans parenthses que j'instancierai les classes sans constructeur ou avec constructeur sans argument dsormais.
L'auto-chargement de classes
Pour une question d'organisation, il vaut mieux crer un fichier par classe. V ous appelez votre fichier comme bon vous semble et placez votre classe dedans. Pour ma part, mes fichiers sont toujours appels MaClasse.class.php . Ainsi, si je veux pouvoir utiliser la classe MaClasse, je n'aurais qu' inclure ce fichier : Code : PHP <?php require 'MaClasse.class.php'; // J'inclus la classe. $objet = new MaClasse(); // Puis, seulement aprs, je me sers de ma classe.
www.siteduzero.com
25/333
Maintenant, imaginons que vous ayez plusieurs dizaines de classes Pas trs pratique de les inclure une par une ! V ous vous retrouverez avec des dizaines d'inclusions, certaines pouvant mme tre inutile si vous ne vous servez pas de toutes vos classes. Et c'est l qu'intervient l'auto-chargement des classes. V ous pouvez crer dans votre fichier principal (c'est--dire celui o vous crerez une instance de votre classe) une ou plusieurs fonction(s) qui tenteront de charger le fichier dclarant la classe. Dans la plupart des cas, une seule fonction suffit. Ces fonctions doivent accepter un paramtre, c'est le nom de la classe qu'on doit tenter de charger. Par exemple, voici une fonction qui aura pour rle de charger les classes : Code : PHP <?php function chargerClasse($classe) { require $classe . '.class.php'; // On inclut la classe correspondante au paramtre pass. } ?>
Essayons maintenant de crer un objet pour voir si il sera charg automatiquement (je prends pour exemple la classe Personnage et prends en compte le fait qu'un fichier Personnage.class.php existe). Code : PHP <?php function chargerClasse($classe) { require $classe . '.class.php'; // On inclut la classe correspondante au paramtre pass. } $perso = new Personnage(); // Instanciation de la classe Personnage qui n'est pas dclare dans ce fichier. ?>
Et l Bam ! Erreur fatale ! La classe n'a pas t trouve, elle n'a donc pas t charge Normal quand on y rflchi ! PHP ne sait pas qu'il doit appeler cette fonction lorsqu'on essaye d'instancier une classe non dclare. On va donc utiliser la fonction spl_autoload_register en spcifiant en premier paramtre le nom de la fonction charger : Code : PHP <?php function chargerClasse($classe) { require $classe . '.class.php'; // On inclut la classe correspondante au paramtre pass. } spl_autoload_register('chargerClasse'); // On enregistre la fonction en autoload pour qu'elle soit appele ds qu'on instanciera une classe non dclare. $perso = new Personnage(); ?>
Et l, comme par magie, aucune erreur ne s'affiche ! Notre auto-chargement a donc bien fonctionn. Dcortiquons ce qui s'est pass. En PHP, il y a ce qu'on appelle une pile d'autoloads . Cette pile contient une liste de fonctions. Chacune d'entre elles sera appele automatiquement par PHP lorsque l'on essaye d'instancier une classe non dclare.
www.siteduzero.com
26/333
Nous avons donc ici ajout notre fonction la pile d'autoloads afin qu'elle soit appele chaque fois qu'on essaye d'instancier une classe non dclare. Schmatiquement, la figure suivante montre ce qui s'est pass.
L'autoload en PHP
Sachez que vous pouvez enregistrer autant de fonctions en autoload que vous le voulez avec spl_autoload_register. Si vous en enregistrez plusieurs, elles seront appeles dans l'ordre de leur enregistrement jusqu' ce que la classe soit charge. Pour y parvenir, il suffit d'appeler spl_autoload_register pour chaque fonction enregistrer. V oici un chapitre aussi essentiel que le premier et toujours aussi riche en nouveauts fondant les bases de la POO. Prenez bien le temps de lire et relire ce chapitre si vous tes un peu perdus, sinon vous ne pourrez jamais suivre !
En rsum
Un objet se cre grce l'oprateur new. L'accs un attribut ou une mthode d'un objet se fait grce l'oprateur -> . Pour lire ou modifier un attribut, on utilise des accesseurs et des mutateurs. Le constructeur d'une classe a pour rle principal d'initialiser l'objet en cours de cration, c'est--dire d'initialiser la valeur des attributs (soit en assignant directement des valeurs spcifiques, soit en appelant diverses mthodes). Les classes peuvent tre charges dynamiquement (c'est--dire sans avoir explicitement inclus le fichier la dclarant) grce l'auto-chargement de classe (utilisation de spl_autoload_register).
www.siteduzero.com
27/333
Pourquoi est-il muet ? Tout simplement parce qu'on ne sait pas quoi 50 correspond. Qu'est-ce que cela veut dire ? tant donn que je viens de raliser le script, je sais que ce 50 correspond la force du personnage. Cependant, ce paramtre ne peut prendre que 3 valeurs possibles : 20, qui veut dire que le personnage aura une faible force ; 50, qui veut dire que le personnage aura une force moyenne ; 80, qui veut dire que le personnage sera trs fort. Au lieu de passer ces valeurs telles quelles, on va plutt passer une constante au constructeur. Ainsi, quand on lira le code, on devinera facilement que l'on passe une force moyenne au constructeur. C'est bien plus facile comprendre qu'un nombre quelconque. Une constante est une sorte d'attribut appartenant la classe dont la valeur ne change jamais. Ceci est peut-tre un peu flou, c'est pourquoi nous allons passer la pratique. Pour dclarer une constante, vous devez faire prcder son nom du mot-cl const. Faites bien attention, une constante ne prend pas de $ devant son nom ! V oici donc comment crer une constante : Code : PHP <?php class Personnage { // Je rappelle : tous les attributs en priv ! private private private private $_force; $_localisation; $_experience; $_degats;
// Dclarations des constantes en rapport avec la force. const FORCE_PETITE = 20; const FORCE_MOYENNE = 50; const FORCE_GRANDE = 80; public function __construct() { }
www.siteduzero.com
28/333
Et voil ! Facile n'est-ce pas ? Bien sr, vous pouvez assigner ces constantes d'autres valeurs. Et quel est le rapport avec tes double deux points ?
Contrairement aux attributs, vous ne pouvez accder ces valeurs via l'oprateur -> depuis un objet (ni $this ni $perso ne fonctionneront) mais avec l'oprateur :: car une constante appartient la classe et non un quelconque objet. Pour accder une constante, vous devez spcifier le nom de la classe, suivi du symbole double deux points, suivi du nom de la constante. Ainsi, on pourrait imaginer un code comme celui-ci : Code : PHP <?php class Personnage { private $_force; private $_localisation; private $_experience; private $_degats; // Dclarations des constantes en rapport avec la force. const FORCE_PETITE = 20; const FORCE_MOYENNE = 50; const FORCE_GRANDE = 80; public function __construct($forceInitiale) { // N'oubliez pas qu'il faut assigner la valeur d'un attribut uniquement depuis son setter ! $this->setForce($forceInitiale); } public function deplacer() { } public function frapper() { } public function gagnerExperience()
www.siteduzero.com
29/333
Et lors de la cration de notre personnage : Code : PHP <?php // On envoie une FORCE_MOYENNE en guise de force initiale. $perso = new Personnage(Personnage::FORCE_MOYENNE); ?>
Notez qu'ici les noms de constantes sont en majuscules : c'est encore et toujours une convention de dnomination.
Reconnaissez que ce code est plus lisible que celui montr au dbut de cette sous-partie.
Pour dclarer une mthode statique, vous devez faire prcder le mot-cl function du mot-cl static aprs le type de visibilit. Code : PHP <?php class Personnage { private $_force; private $_localisation; private $_experience; private $_degats; const FORCE_PETITE = 20; const FORCE_MOYENNE = 50; const FORCE_GRANDE = 80;
www.siteduzero.com
30/333
Et dans le code, vous pourrez faire : Code : PHP <?php Personnage::parler(); ?>
Comme je l'ai dit plus haut, vous pouvez aussi appeler la mthode depuis un objet, mais cela ne changera rien au rsultat final : Code : PHP <?php $perso = new Personnage(Personnage::FORCE_GRANDE); $perso->parler(); ?>
Cependant, prfrez appeler la mthode avec l'oprateur :: comme le montre le premier de ces deux codes. De cette faon, on voit directement de quelle classe on dcide d'invoquer la mthode. De plus, appeler de cette faon une mthode statique vitera
www.siteduzero.com
31/333
Je me rpte mais j'insiste l-dessus : il n'y a pas de variable $this dans la mthode dans la mesure o la mthode est invoque afin d'agir sur la classe et non sur un quelconque objet !
www.siteduzero.com
32/333
Quelques nouveauts dans ce code ncessitent des explications. Premirement, quoi sert un attribut statique ? Nous avons vu que les mthodes statiques sont faites pour agir sur la classe. D'accord, mais qu'est-ce qu'on peut faire sur une classe ? Et bien tout simplement modifier les attributs de celle-ci car, comme je l'ai dj dit, des attributs appartenant une classe ne sont autre que des attributs statiques ! Les attributs statiques servent en particulier avoir des attributs indpendants de tout objet . Ainsi, vous aurez beau crer des tas d'objets, votre attribut aura toujours la mme valeur (sauf si l'objet modifie sa valeur, bien sr). Mieux encore : si l'un des objets modifie sa valeur, tous les autres objets qui accderont cet attribut obtiendront la nouvelle valeur ! C'est logique quand on y pense, car un attribut statique appartenant la classe, il n'existe qu'en un seul exemplaire. Si on le modifie, tout le monde pourra accder sa nouvelle valeur. La ligne 47 commence avec le mot-cl self, ce qui veut dire (en gros) moi-mme (= la classe). Notre ligne veut donc dire : Dans moi-mme, donne-moi l'attribut statique $_texteADire. (Je sais ce n'est pas bien franais mais c'est la meilleure traduction mot mot que j'ai pu trouver.) N'oubliez pas de mettre un $ devant le nom de l'attribut. C'est souvent source d'erreur donc faites bien attention.
Nous allons maintenant faire un petit exercice. Je veux que vous me fassiez une classe toute bte qui ne sert rien. Seulement, la fin du script, je veux pouvoir afficher le nombre de fois o la classe a t instancie. Pour cela, vous aurez besoin d'un attribut appartenant la classe (admettons $_compteur) qui est incrment dans le constructeur. V oici la correction : Code : PHP <?php class Compteur { // Dclaration de la variable $compteur private static $_compteur = 0; public function __construct() { // On instancie la variable $compteur qui appartient la classe (donc utilisation du mot-cl self). self::$_compteur++; } public static function getCompteur() // Mthode statique qui renverra la valeur du compteur. { return self::$_compteur; } } $test1 = new Compteur; $test2 = new Compteur; $test3 = new Compteur; echo Compteur::getCompteur(); ?>
Eh oui, le retour du mot-cl self Pourquoi pas $this ? Souvenez-vous : on n'accde pas un attribut statique avec $this mais avec self ! self reprsente la classe tandis que $this reprsente l'objet actuellement cr. Si un attribut statique est modifi, il n'est pas modifi uniquement dans l'objet cr mais dans la structure complte de la classe ! Je me rpte, mais il est essentiel que vous compreniez a, c'est trs important.
En rsum
www.siteduzero.com
33/333
L'oprateur -> permet d'accder un lment de tel objet, tandis que l'oprateur :: permet d'accder un lment de telle classe. Au sein d'une mthode, on accde l'objet grce la pseudo-variable $this, tandis qu'on accde la classe grce au mot-cl self. Les attributs et mthodes statiques ainsi que les constantes de classe sont des lments propres la classe, c'est--dire qu'il n'est pas utile de crer un objet pour s'en servir. Les constantes de classe sont utiles pour viter d'avoir un code muet, c'est--dire un code qui, sans commentaire, ne nous informe pas vraiment sur son fonctionnement. Les attributs et mthodes statiques sont utiles lorsque l'on ne veut pas avoir besoin d'un objet pour s'en servir.
www.siteduzero.com
34/333
personnages Nous voyons ici que notre table contient 3 personnages. Ces donnes sont stockes sous forme d'entres. C'est sous cette forme que le gestionnaire de la BDD (MySQL, PostgreSQL, etc.) manipule les donnes. Si l'on regarde du ct de l'application qui les manipule (ici, notre script PHP), on se rend compte que c'est sous une forme similaire que les donnes sont rcupres. Cette forme utilise, vous la connaissez bien : vous utilisiez jusqu' prsent des tableaux pour les manipuler. Exemple : Code : PHP <?php // On admet que $db est un objet PDO $request = $db->query('SELECT id, nom, forcePerso, degats, niveau, experience FROM personnages'); while ($perso = $request->fetch(PDO::FETCH_ASSOC)) // Chaque entre sera rcupre et place dans un array. { echo $perso['nom'], ' a ', $perso['forcePerso'], ' de force, ', $perso['degats'], ' de dgts, ', $perso['experience'], ' d\'exprience et est au niveau ', $perso['niveau']; }
a, si vous avez dj fait un site internet de A Z, vous avez du l'crire pas mal de fois ! Pour les exemples, et dans la suite du cours, j'utilise l'API PDO pour accder la base de donnes. Je vous conseille de lire le cours de M@teo21 sur PDO pour tre l'aise avec !
Maintenant, puisque nous programmons de manire oriente objet, nous voulons travailler seulement avec des objets (c'est le principe mme de la POO, rappelons-le)et non plus avec des tableaux. En d'autres termes, il va falloir transformer le tableau que l'on reoit en objet.
www.siteduzero.com
35/333
Vient maintenant une question embtante dans votre tte pour construire cette classe : Je commence par o ? Une classe est compose de deux parties (ventuellement trois) : une partie dclarant les attributs. Ce sont les caractristiques de l'objet ; une partie dclarant les mthodes. Ce sont les fonctionnalits de chaque objet ; ventuellement, une partie dclarant les constantes de classe. Nous nous en occuperons en temps voulu. Lorsque l'on veut construire une classe, il va donc falloir systmatiquement se poser les mmes questions : Quelles seront les caractristiques de mes objets ? Quelles seront les fonctionnalits de mes objets ? Les rponses ces questions aboutiront la ralisation du plan de la classe, le plus difficile. Commenons donc rflchir sur le plan de notre classe en rpondant la premire question : Quelles seront les caractristiques de mes objets ? Pour vous mettre sur la piste, regardez de nouveau le tableau de la BDD contenant les entres, cela vous donnera peut-tre la rponse Et oui, les attributs de notre classe (les caractristiques) nous sont offerts sur un plateau ! Ils sont lists en haut du tableau : id, nom, forcePerso, degats, niveau et experience. crivons maintenant notre classe : Code : PHP <?php class Personnage { private $_id; private $_nom; private $_forcePerso; private $_degats; private $_niveau; private $_experience; } ?>
Il faut bien sr implmenter (crire) les getters et setters qui nous permettront d'accder et de modifier les valeurs de notre objet. Pour rappel, un getter est une mthode charge de renvoyer la valeur d'un attribut, tandis qu'un setter une mthode charge d'assigner une valeur un attribut en vrifiant son intgrit (si vous assignez la valeur sans aucun contrle, vous perdez tout l'intrt qu'apporte le principe d'encapsulation). Pour construire nos setters, il faut donc nous pencher sur les valeurs possibles de chaque attribut : les les les les les les valeurs valeurs valeurs valeurs valeurs valeurs possibles possibles possibles possibles possibles possibles de l'identifiant sont tous les nombres entiers strictement positifs ; pour le nom du personnage sont toutes les chanes de caractres ; pour la force du personnage sont tous les nombres entiers allant de 1 100 ; pour les dgts du personnage sont tous les nombres entiers allant de 0 100 ; pour le niveau du personnage sont tous les nombres entiers allant de 1 100 ; pour l'exprience du personnage sont tous les nombres entiers allant de 1 100.
www.siteduzero.com
36/333
www.siteduzero.com
37/333
public function setForcePerso($forcePerso) { $forcePerso = (int) $forcePerso; if ($forcePerso >= 1 && $forcePerso <= 100) { $this->_forcePerso = $forcePerso; }
public function setDegats($degats) { $degats = (int) $degats; if ($degats >= 0 && $degats <= 100) { $this->_degats = $degats; }
public function setNiveau($niveau) { $niveau = (int) $niveau; if ($niveau >= 1 && $niveau <= 100) { $this->_niveau = $niveau; }
public function setExperience($experience) { $experience = (int) $experience; if ($experience >= 1 && $experience <= 100) { $this->_experience = $experience; }
} ?>
Reprenons notre code de tout l'heure, celui qui nous permettait de lire la BDD. Modifions-le un peu pour qu'on puisse manipuler des objets et non des tableaux : Code : PHP <?php // On admet que $db est un objet PDO. $request = $db->query('SELECT id, nom, forcePerso, degats, niveau, experience FROM personnages'); while ($donnees = $request->fetch(PDO::FETCH_ASSOC)) // Chaque entre sera rcupre et place dans un array. { // On passe les donnes (stockes dans un tableau) concernant le personnage au constructeur de la classe. // On admet que le constructeur de la classe appelle chaque setter pour assigner les valeurs qu'on lui a donnes aux attributs
www.siteduzero.com
38/333
Les mthodes concernent des fonctionnalits que possde l'objet, des actions qu'il peut effectuer. V oyez-vous des fonctionnalits intressantes implmenter ? Pour les oprations basiques que l'on effectue, il n'y en a pas besoin. En effet, nous voulons juste crer des objets et assigner des valeurs aux attributs, donc hormis les getters et setters, aucune autre mthode n'est ncessaire ! D'accord, nous avons des objets maintenant. Mais quoi cela sert-il, concrtement ?
Il est sr que dans cet exemple prcis, cela ne sert rien. Mais vous verrez plus tard qu'il est beaucoup plus intuitif de travailler avec des objets et par consquent beaucoup plus pratique, notamment sur de grosses applications o de nombreux objets circulent un peu dans tous les sens.
www.siteduzero.com
39/333
Au dbut, nous avons un objet Personnage dont les attributs sont vides. Comme le schma le reprsente, l'hydratation consiste assigner des valeurs aux attributs. Ainsi l'objet est fonctionnel car il contient des attributs valides : nous avons donc bien hydrat l'objet.
L'hydratation en pratique
Comme on l'a vu, hydrater un objet revient assigner des valeurs ses attributs. Qu'avons-nous besoin de faire pour raliser une telle chose ? Il faut ajouter l'objet l'action de s'hydrater. Et qui dit action dit mthode ! Nous allons donc crire notre fonction hydrate() : Code : PHP <?php class Personnage { private $_id; private $_nom; private $_forcePerso; private $_degats; private $_niveau; private $_experience;
www.siteduzero.com
40/333
public function setId($id) { // L'identifiant du personnage sera, quoi qu'il arrive, un nombre entier. $this->_id = (int) $id; } public function setNom($nom) { // On vrifie qu'il s'agit bien d'une chane de caractres. // Dont la longueur est infrieure 30 caractres. if (is_string($nom) && strlen($nom) <= 30) { $this->_nom = $nom; } } public function setForcePerso($forcePerso) { $forcePerso = (int) $forcePerso; // On vrifie que la force passe est comprise entre 0 et 100. if ($forcePerso >= 0 && $forcePerso <= 100) { $this->_forcePerso = $forcePerso; }
public function setDegats($degats) { $degats = (int) $degats; 100. // On vrifie que les dgts passs sont compris entre 0 et if ($degats >= 0 && $degats <= 100) { $this->_degats = $degats; }
public function setNiveau($niveau) { $niveau = (int) $niveau; // On vrifie que le niveau n'est pas ngatif. if ($niveau >= 0) { $this->_niveau = $niveau; }
www.siteduzero.com
41/333
} ?>
Vient maintenant l'apect le plus important : que doit-on mettre dans cette mthode ? Souvenez-vous de sa fonction : elle doit hydrater l'objet, c'est--dire assigner les valeurs passes en paramtres aux attributs correspondant . Cependant, je vous le dis avant que vous fassiez fausse route : il ne faut pas assigner ces valeurs directement, comme ceci : Code : PHP <?php // public function hydrate(array $donnees) { if (isset($donnees['id'])) { $this->_id = $donnees['id']; } if (isset($donnees['nom'])) { $this->_nom = $donnees['nom']; } // } // ?>
La principale raison pour laquelle c'est une mauvaise faon de procder, est qu'en agissant ainsi vous violez le principe d'encapsulation. En effet, de cette manire, vous ne contrlez pas l'intgrit des valeurs. Qui vous garantit que le tableau contiendra un nom valide ? Rien du tout! Comment contrler alors l'intgrit de ces valeurs ? Regardez un peu votre classe, la rponse est sous vos yeux C'est le rle des setters de faire ces vrifications ! Il faudra donc les appeler au lieu d'assigner les valeurs directement : Code : PHP <?php // public function hydrate(array $donnees) { if (isset($donnees['id'])) { $this->setId($donnees['id']); } if (isset($donnees['nom'])) { $this->setNom($donnees['nom']); } // } // ?>
www.siteduzero.com
42/333
Thoriquement, nous avons termin le travail. Cependant, cela n'est pas trs flexible : si vous ajoutez un attribut (et donc son setter correspondant), il faudra modifier votre mthode hydrate() pour ajouter la possibilit d'assigner cette valeur. De plus, avec les 6 attributs actuellement crs, il est long de vrifier si la cl existe puis d'appeler la mthode correspondante. Nous allons donc procder plus rapidement : nous allons crer une boucle qui va parcourir le tableau pass en paramtre. Si le setter correspondant la cl existe, alors on appelle ce setter en lui passant la valeur en paramtre. En langage naturel, l'algorithme peut s'crire de cette faon : Code : Autre PARCOURS du tableau $donnees (avec pour cl $cle et pour valeur $valeur) On assigne $setter la valeur 'set'.$cle , en mettant la premire lettre de $cle SI la mthode $setter de notre classe existe ALORS On invoque $setter($valeur) FIN SI FIN PARCOURS
Pas de panique, je vais vous expliquer chaque ligne. Dans votre tte, prenez un exemple de valeur pour $donnees : Code : PHP <?php $donnees = array( 'id' => 16, 'nom' => 'Vyk12', 'forcePerso' => 5, 'degats' => 55, 'niveau' => 4, 'experience' => 20 ); ?>
V ous voyez bien que chaque cl correspond un attribut de notre objet, qui on assigne une valeur prcise. Dans notre mthode hydrate(), lorsqu'on parcourt notre tableau, on a successivement la cl id, puis nom, puis forcePerso, etc., avec leur valeur correspondante. En rcuprant le nom de l'attribut, il est facile de dterminer le setter correspondant. En effet, chaque setter a pour nom setNomDeLAttribut. Il est important de prciser que la premire lettre du nom de l'attribut doit tre en majuscule. Par exemple, le setter correspondant nom est setNom.
Pour l'instant notre mthode ressemble ceci : Code : PHP <?php // public function hydrate(array $donnees) { foreach ($donnees as $key => $value) { $method = 'set'.ucfirst($key); // } } //
www.siteduzero.com
43/333
Il faut maintenant vrifier que la mthode existe. Pour cela, nous allons utiliser la fonction method_exists(). Elle prend en premier paramtre le nom de la classe ou une instance de cette classe, et en deuxime paramtre le nom de la mthode qui nous intresse. La mthode renvoie true si la mthode existe, sinon false. Je vous laisse ajouter cette condition qui permet de voir si le setter correspondant existe. V oici la correction : Code : PHP <?php // public function hydrate(array $donnees) { foreach ($donnees as $key => $value) { $method = 'set'.ucfirst($key); if (method_exists($this, $method)) { // }
} } // ?>
Et maintenant, il ne reste plus qu' appeler le setter l'intrieur de la condition ! Pour cela, je vais vous apprendre une petite astuce. Il est possible d'appeler une mthode dynamiquement, c'est--dire appeler une mthode dont le nom n'est pas connu l'avance (en d'autres termes, le nom est connu seulement pendant l'excution et est donc stock dans une variable). Pour ce faire, rien de plus simple ! Regardez ce code : Code : PHP <?php class A { public function hello() { echo 'Hello world !'; } } $a = new A; $method = 'hello'; $a->$method(); // Affiche : Hello world ! ?>
V ous tes maintenant capables de crer la dernire instruction dans notre mthode ! Pour rappel, celle-ci doit invoquer le setter dont le nom est contenu dans la variable $method.
www.siteduzero.com
44/333
} } // ?>
Cette fonction est trs importante, vous la retrouverez dans de nombreux codes (parfois sous des formes diffrentes) provenant de plusieurs dveloppeurs. Gardez-l donc dans un coin de votre tte. Il est courant d'implmenter un constructeur ces classes demandant un tableau de valeurs pour qu'il appelle ensuite la fonction d'hydratation afin que l'objet soit hydrat ds sa cration, comme on l'a vu au dbut de ce chapitre.
www.siteduzero.com
45/333
C'est le fameux CRUD (Create, Read, Update, Delete). N'oublions pas aussi d'ajouter un setter pour notre manager afin de pouvoir modifier l'attribut $_db (pas besoin d'accesseur). La cration d'un constructeur sera aussi indispensable si nous voulons assigner cet attribut un objet PDO ds l'instanciation du manager. Nous allons donc crire notre premier manager en crivant les mthodes correspondant ces fonctionnalits. crivez dans un premier temps les mthodes en ne les remplissant que de commentaires dcrivant les instructions qui y seront crites. Cela vous permettra d'organiser clairement le code dans votre tte. Code : PHP <?php class PersonnagesManager { private $_db; // Instance de PDO. public function __construct($db) { $this->setDb($db); } public function add(Personnage $perso)
www.siteduzero.com
46/333
} ?>
Une fois cette tape accomplie, vous pouvez remplacer les commentaires par les instructions correspondantes. C'est la partie la plus facile car vous l'avez dj fait de nombreuses fois en procdural : ce ne sont que des requtes taper et des valeurs retourner. Code : PHP <?php class PersonnagesManager { private $_db; // Instance de PDO public function __construct($db) { $this->setDb($db); } public function add(Personnage $perso) { $q = $this->_db->prepare('INSERT INTO personnages SET nom = :nom, forcePerso = :forcePerso, degats = :degats, niveau = :niveau, experience = :experience'); $q->bindValue(':nom', $perso->nom()); $q->bindValue(':forcePerso', $perso->forcePerso(), PDO::PARAM_INT); $q->bindValue(':degats', $perso->degats(), PDO::PARAM_INT); $q->bindValue(':niveau', $perso->niveau(), PDO::PARAM_INT); $q->bindValue(':experience', $perso->experience(), PDO::PARAM_INT);
www.siteduzero.com
47/333
public function delete(Personnage $perso) { $this->_db->exec('DELETE FROM personnages WHERE id = '.$perso>id()); } public function get($id) { $id = (int) $id; $q = $this->_db->query('SELECT id, nom, forcePerso, degats, niveau, experience FROM personnages WHERE id = '.$id); $donnees = $q->fetch(PDO::FETCH_ASSOC); } return new Personnage($donnees);
public function getList() { $persos = array(); $q = $this->_db->query('SELECT id, nom, forcePerso, degats, niveau, experience FROM personnages ORDER BY nom'); while ($donnees = $q->fetch(PDO::FETCH_ASSOC)) { $persos[] = new Personnage($donnees); } } return $persos;
public function update(Personnage $perso) { $q = $this->_db->prepare('UPDATE personnages SET forcePerso = :forcePerso, degats = :degats, niveau = :niveau, experience = :experience WHERE id = :id'); $q->bindValue(':forcePerso', $perso->forcePerso(), PDO::PARAM_INT); $q->bindValue(':degats', $perso->degats(), PDO::PARAM_INT); $q->bindValue(':niveau', $perso->niveau(), PDO::PARAM_INT); $q->bindValue(':experience', $perso->experience(), PDO::PARAM_INT); $q->bindValue(':id', $perso->id(), PDO::PARAM_INT); } $q->execute();
} ?>
Essayons tout a !
Faisons un petit test pour s'assurer que tout cela fonctionne. Assurez-vous de bien avoir cr une table personnages dans votre BDD.
www.siteduzero.com
48/333
Commenons par crer un objet Personnage : Code : PHP <?php $perso = new Personnage(array( 'nom' => 'Victor', 'forcePerso' => 5, 'degats' => 0, 'niveau' => 1, 'experience' => 0 )); ?>
Maintenant, comment l'ajouter en BDD ? Il faudra d'abord crer une instance de notre manager, en lui passant une instance de PDO. Code : PHP <?php $perso = new Personnage(array( 'nom' => 'Victor', 'forcePerso' => 5, 'degats' => 0, 'niveau' => 1, 'experience' => 0 )); $db = new PDO('mysql:host=localhost;dbname=tests', 'root', ''); $manager = new PersonnagesManager($db); ?>
Nous n'avons plus qu'une instruction entrer : celle ordonnant l'ajout du personnage en BDD. Et c'est tout ! Code : PHP <?php $perso = new Personnage(array( 'nom' => 'Victor', 'forcePerso' => 5, 'degats' => 0, 'niveau' => 1, 'experience' => 0 )); $db = new PDO('mysql:host=localhost;dbname=tests', 'root', ''); $manager = new PersonnagesManager($db); $manager->add($perso); ?> Il est maintenant temps de mettre en pratique ce que vous venez d'apprendre. Cependant, avant de continuer, assurez-vous bien de tout avoir compris, sinon vous serez perdus car vous ne comprendrez pas le code du TP !
En rsum
Du ct du script PHP, chaque enregistrement de la base de donnes est reprsent par un objet possdant une liste
www.siteduzero.com
49/333
d'attributs identique la liste des colonnes de la table. Il doit tre possible d'hydrater chacun des objets grce une mthode hydrate qui a pour rle d'assigner les valeurs passes en paramtre aux attributs correspondant. La communication avec la BDD se fait par le biais d'un objet diffrent de l'objet reprsentant l'enregistrement (une classe = un rle). Un tel objet est un manager. Un manager peut stocker les objets en BDD, mais peut tout--fait les stocker sur un autre support (fichier XML, fichier texte, etc.).
www.siteduzero.com
50/333
TP : Mini-jeu de combat
V oici un petit TP qui mettra en pratique ce que l'on vient de voir. Celui-ci est troitement li avec le prcdent chapitre. Ainsi, je vous conseille d'avoir bien compris ce dernier avant d'aborder ce TP, sinon vous n'arriverez sans doute pas au rsultat tout seul. En tout, vous aurez 3 TP de la sorte dont le niveau de difficult sera croissant. Puisque celui-ci est votre premier, tout sera expliqu dans les moindres dtails.
Ce qu'on va faire
Pour information, j'utilise ici PDO. Si vous ne savez toujours pas maitriser cette API, alors allez lire le tutoriel PDO : Interface d'accs aux BDD. V ous avez les connaissances requises pour pouvoir manipuler cette bibliothque.
Notions utilises
V oici une petite liste vous indiquant les points techniques que l'on va mettre en pratique avec ce TP : Les attributs et mthodes ; l'instanciation de la classe ; les constantes de classe ; et surtout, tout ce qui touche la manipulation de donnes stockes . Cela dit, et c'est je pense ce qui sera le plus difficile, ce qui sera mis en valeur ici sera la conception d'un mini-projet, c'est--dire que l'on travaillera surtout ici votre capacit programmer orient objet. Cependant, ne prenez pas trop peur : nous avons effectu une importante partie thorique lors du prcdent chapitre, et rien de nouveau napparatra. V ous avez donc maintenant une ide de ce qui vous attend. Cependant, ceci tant votre premier TP concernant la POO, il est fort probable que vous ne sachiez pas par o commencer, et c'est normal ! nous allons donc raliser le TP ensemble : je vais vous expliquer comment penser un mini-projet et vous poser les bonnes questions.
Pr-conception
Avant de nous attaquer au cur du script, nous allons rflchir son organisation. De quoi aura-t-on besoin ? Puisque nous travaillerons avec des personnages, nous aurons besoin de les stocker pour qu'ils puissent durer dans le temps. L'utilisation d'une base de donnes sera donc indispensable. Le script tant simple, nous n'aurons qu'une table personnages qui aura diffrents champs. Pour les dfinir, rflchissez ce qui caractrise un personnage. Ainsi nous connaissons dj 2 champs de cette table que nous avons dfinis au dbut : nom et dgts . Et bien sr, n'oublions pas le plus important : l'identifiant du personnage ! Chaque personnage doit possder un identifiant unique qui permet ainsi de le rechercher plus rapidement (au niveau performances) qu'avec son nom. V ous pouvez donc ainsi crer votre table tous seuls via PhpMyAdmin. Si vous n'tes pas srs de vous, je vous laisse le code SQL crant cette table : Code : SQL CREATE TABLE IF NOT EXISTS `personnages` (
www.siteduzero.com
51/333
V oici comment procder. Nous allons dans un premier temps dresser la liste des caractristiques du personnage pour ensuite se pencher sur ses fonctionnalits. Rappel : le traitement des donnes (c'est--dire l'excution de requtes permettant d'aller effectuer des oprations en BDD) se fera dans une autre classe. Ne vous en proccupez donc pas maintenant !
Si vous n'avez pas retenu cette information, notez-l quelque part, vous en aurez besoin un trs grand nombre de fois. Maintenant que nous avons dtermin les caractristiques d'un objet Personnage, nous savons quels attributs placer dans notre classe. V oici une premire criture de notre classe Personnage : Code : PHP <?php class Personnage { private $_id, $_degats, $_nom; }
Jusque l tout va bien. Tournons-nous maintenant vers les fonctionnalits que doit possder un personnage.
52/333
Comme nous l'avons dit tout--l'heure, pour obtenir les mthodes d'un objet, il faut se demander quelles seront les fonctionnalits de ces entits. Ici, que pourra faire un personnage ? Relisez les consignes du dbut de chapitre et rpondez clairement la question. Un personnage doit pouvoir : Frapper un autre personnage ; recevoir des dgts.
chaque fonctionnalit correspond une mthode. crivez ces mthodes dans la classe en mettant en commentaire ce qu'elles doivent faire. Ne vous tonnez pas si vous avez un rsultat bien diffrent du mien. Le contenu des mthodes importe peu car il est issu de mon imagination et il est normal que vous n'ayez pas pens le script comme moi. Gardez votre version, n'essayez pas de copier/coller mon code.
Code : PHP <?php class Personnage { private $_id, $_degats, $_nom; public function frapper(Personnage $perso) { // Avant tout : vrifier qu'on ne se frappe pas soi-mme. // Si c'est le cas, on stoppe tout en renvoyant une valeur signifiant que le personnage cibl est le personnage qui attaque. // On indique au personnage frapp qu'il doit recevoir des dgts. } public function recevoirDegats() { // On augmente de 5 les dgts. // Si on a 100 de dgts ou plus, la mthode renverra une valeur signifiant que le personnage a t tu. // Sinon, elle renverra une valeur signifiant que le personnage a bien t frapp. } }
Tout ceci n'est que du franais, nous sommes encore l'tape de rflexion. Si vous sentez que a va trop vite, relisez le dbut du TP et suivez bien les tapes. C'est trs important car c'est en gnral cette tape qui pose problme : la rflexion ! Beaucoup de dbutants foncent tte baisse sans rendre le temps de concevoir correctement les mthodes au dbut et se plantent royalement. Prenez donc bien votre temps. Normalement, des petites choses doivent vous chiffonner. Pour commencer, la premire chose qui doit vous interpeller se situe dans la mthode frapper(), lorsqu'il faut vrifier qu'on ne se frappe pas soi-mme. Pour cela, il suffit de comparer l'identifiant du personnage qui attaque avec l'identifiant du personnage cibl. En effet, si l'identifiant est le mme, alors il s'agira d'un seul et mme personnage. Ensuite, certains moments dans le code, il est dit que la mthode renverra une valeur signifiant que le personnage a bien t frapp par exemple. Qu'est-ce que cela peut bien signifier ? Ce genre de commentaire laissera place des constantes de classe
www.siteduzero.com
53/333
Mthode frapper() : [...] renvoyant une valeur signifiant que le personnage cibl est le personnage qui attaque la mthode renverra la valeur de la constante CEST_MOI ; Mthode recevoirDegats() : la mthode renverra une valeur signifiant que le personnage a t tu la mthode renverra la valeur de la constante PERSONNAGE_TUE ; Mthode recevoirDegats() : elle renverra une valeur signifiant que le personnage a bien t frapp la mthode renverra la valeur de la constante PERSONNAGE_FRAPPE. V ous pouvez ajouter ces constantes votre classe. Code : PHP <?php class Personnage { private $_id, $_degats, $_nom; const CEST_MOI = 1; const PERSONNAGE_TUE = 2; const PERSONNAGE_FRAPPE = 3; public function { // Avant tout // Si c'est signifiant que le frapper(Personnage $perso) : vrifier qu'on ne se frappe pas soi-mme. le cas, on stoppe tout en renvoyant une valeur personnage cibl est le personnage qui attaque.
// On indique au personnage frapp qu'il doit recevoir des dgts. } public function recevoirDegats() { // On augmente de 5 les dgts. // Si on a 100 de dgts ou plus, la mthode renverra une valeur signifiant que le personnage a t tu. // Sinon, elle renverra une valeur signifiant que le personnage a bien t frapp. } }
www.siteduzero.com
54/333
// On indique au personnage frapp qu'il doit recevoir des dgts. } public function recevoirDegats() { // On augmente de 5 les dgts. // Si on a 100 de dgts ou plus, la mthode renverra une valeur signifiant que le personnage a t tu. // Sinon, elle renverra une valeur signifiant que le personnage a bien t frapp. } public function degats() { return $this->_degats; } public function id() { return $this->_id; } public function nom() { return $this->_nom; } public function setDegats($degats) { $degats = (int) $degats; if ($degats >= 0 && $degats <= 100) { $this->_degats = $degats; }
public function setId($id) { $id = (int) $id; if ($id > 0) { $this->_id = $id; }
www.siteduzero.com
55/333
} }
// ...
Il ne manque plus qu' implmenter le constructeur pour qu'on puisse directement hydrater notre objet lors de l'instanciation de la classe. Pour cela, ajoutez un paramtre : $donnees. Appelez ensuite directement la mthode hydrate(). Code : PHP <?php class Personnage { // ... public function __construct(array $donnees) { $this->hydrate($donnees); } } // ...
Codons le tout !
La partie rflexion est termin, il est maintenant temps d'crire notre classe Personnage ! V oici la correction que je vous propose : Code : PHP
www.siteduzero.com
56/333
public function recevoirDegats() { $this->_degats += 5; // Si on a 100 de dgts ou plus, on dit que le personnage a t tu. if ($this->_degats >= 100) { return self::PERSONNAGE_TUE; } // Sinon, on se contente de dire que le personnage a bien t frapp. return self::PERSONNAGE_FRAPPE; } // GETTERS // public function degats() { return $this->_degats;
www.siteduzero.com
57/333
public function setId($id) { $id = (int) $id; if ($id > 0) { $this->_id = $id; }
Prenez le temps de bien comprendre ce code et de lire les commentaires. Il est important que vous cerniez son fonctionnement pour savoir ce que vous faites. Cependant, si vous ne comprenez pas toutes les instructions places dans les mthodes, ne vous affolez pas : si vous avez compris globalement le rle de chacune d'elles, vous n'aurez pas de handicap pour suivre la prochaine sous-partie.
La classe Personnage a pour rle de reprsenter un personnage prsent en BDD. Elle n'a en aucun cas pour rle de les grer. Cette gestion sera le rle d'une autre classe, communment appele manager. Dans notre cas, notre gestionnaire de personnage sera tout simplement nomme PersonnagesManager. Comment va-t-on faire pour construire ces classes ? Quelles questions va-t-on se poser ?
www.siteduzero.com
58/333
Quelles seront les caractristiques d'un manager ? Quelles seront les fonctionnalits d'un manager ?
Cependant, ici, nous pouvons ajouter quelques fonctionnalits qui pourront nous tre utiles : Compter le nombre de personnages ; rcuprer une liste de plusieurs personnages ; savoir si un personnage existe. Cela nous fait ainsi 7 mthodes implmenter ! Rappels du prcdent chapitre : n'oubliez pas d'ajouter un setter pour notre manager afin de pouvoir modifier l'attribut $_db. La cration d'un constructeur sera aussi indispensable si nous voulons assigner cet attribut un objet PDO ds l'instanciation du manager.
Comme d'habitude, crivez le nom des mthodes en ajoutant des commentaires sur ce que doit faire la mthode. Code : PHP <?php class PersonnagesManager { private $_db; // Instance de PDO public function __construct($db) { $this->setDb($db); }
www.siteduzero.com
59/333
Codons le tout !
www.siteduzero.com
60/333
Normalement, l'criture des mthodes devrait tre plus facile que dans la prcdente partie. En effet, ici, il n'y a que des requtes crire : si vous savez utiliser PDO, vous ne devriez pas avoir de mal. Code : PHP <?php class PersonnagesManager { private $_db; // Instance de PDO public function __construct($db) { $this->setDb($db); } public function add(Personnage $perso) { $q = $this->_db->prepare('INSERT INTO personnages SET nom = :nom'); $q->bindValue(':nom', $perso->nom()); $q->execute(); $perso->hydrate(array( 'id' => $this->_db->lastInsertId(), 'degats' => 0, ));
public function count() { return $this->_db->query('SELECT COUNT(*) FROM personnages')>fetchColumn(); } public function delete(Personnage $perso) { $this->_db->exec('DELETE FROM personnages WHERE id = '.$perso>id()); } public function exists($info) { if (is_int($info)) // On veut voir si tel personnage ayant pour id $info existe. { return (bool) $this->_db->query('SELECT COUNT(*) FROM personnages WHERE id = '.$info)->fetchColumn(); } // Sinon, c'est qu'on veut vrifier que le nom existe ou pas. $q = $this->_db->prepare('SELECT COUNT(*) FROM personnages WHERE nom = :nom'); $q->execute(array(':nom' => $info)); } return (bool) $q->fetchColumn();
public function get($info) { if (is_int($info)) { $q = $this->_db->query('SELECT id, nom, degats FROM personnages WHERE id = '.$info); $donnees = $q->fetch(PDO::FETCH_ASSOC); return new Personnage($donnees); } else
www.siteduzero.com
61/333
public function getList($nom) { $persos = array(); $q = $this->_db->prepare('SELECT id, nom, degats FROM personnages WHERE nom <> :nom ORDER BY nom'); $q->execute(array(':nom' => $nom)); while ($donnees = $q->fetch(PDO::FETCH_ASSOC)) { $persos[] = new Personnage($donnees); } } return $persos;
public function update(Personnage $perso) { $q = $this->_db->prepare('UPDATE personnages SET degats = :degats WHERE id = :id'); $q->bindValue(':degats', $perso->degats(), PDO::PARAM_INT); $q->bindValue(':id', $perso->id(), PDO::PARAM_INT); } $q->execute();
www.siteduzero.com
62/333
Vient ensuite la partie traitement. Deux cas peuvent se prsenter : Le joueur a cliqu sur Crer ce personnage. Le script devra crer un objet Personnage en passant au constructeur un tableau contenant une entre (le nom du personnage). Il faudra ensuite s'assurer que le personnage ait un nom valide et qu'il n'existe pas dj. Aprs ces vrifications, l'enregistrement en BDD pourra se faire. Le joueur a cliqu sur Utiliser ce personnage. Le script devra vrifier si le personnage existe bien en BDD. Si c'est le cas, on le rcupre de la BDD.
Pour savoir si le nom du personnage est valide, il va falloir implmenter une mthode nomValide() (je vous laisse rflchir quelle classe) qui retournera true ou false suivant si le nom est valide ou pas. Un nom est valide s'il n'est pas vide.
Cependant, avant de faire cela, il va falloir prparer le terrain. Un autoload devra tre cr (bien que non indispensable puisqu'il n'y a que deux classes). Une instance de PDO devra tre cre. Une instance de notre manager devra tre cre. Puisque notre manager a t cr, pourquoi ne pas afficher en haut de page le nombre de personnages crs ? Code : PHP <?php // On enregistre notre autoload. function chargerClasse($classname) { require $classname.'.class.php'; } spl_autoload_register('chargerClasse'); $db = new PDO('mysql:host=localhost;dbname=combats', 'root', ''); $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_WARNING); // On met une alerte chaque fois qu'une requte a chou. $manager = new PersonnagesManager($db); if (isset($_POST['creer']) && isset($_POST['nom'])) // Si on a voulu crer un personnage. { $perso = new Personnage(array('nom' => $_POST['nom'])); // On cre un nouveau personnage. if (!$perso->nomValide()) { $message = 'Le nom choisi est invalide.'; unset($perso); } elseif ($manager->exists($perso->nom())) { $message = 'Le nom du personnage est dj pris.'; unset($perso);
www.siteduzero.com
63/333
elseif (isset($_POST['utiliser']) && isset($_POST['nom'])) // Si on a voulu utiliser un personnage. { if ($manager->exists($_POST['nom'])) // Si celui-ci existe. { $perso = $manager->get($_POST['nom']); } else { $message = 'Ce personnage n\'existe pas !'; // S'il n'existe pas, on affichera ce message. } } ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr"> <head> <title>TP : Mini jeu de combat</title> <meta http-equiv="Content-type" content="text/html; charset=iso8859-1" /> </head> <body> <p>Nombre de personnages crs : <?php echo $manager->count(); ? ></p> <?php if (isset($message)) // On a un message afficher ? echo '<p>', $message, '</p>'; // Si oui, on l'affiche. ?> <form action="" method="post"> <p> Nom : <input type="text" name="nom" maxlength="50" /> <input type="submit" value="Crer ce personnage" name="creer" /> <input type="submit" value="Utiliser ce personnage" name="utiliser" /> </p> </form> </body> </html>
Au cas o, je vous donne la mthode nomValide() de la classe Personnage. J'espre cependant que vous y tes arrivs, un simple contrle avec empty() et le tour est jou. Code : PHP <?php class Personnage { // ... public function nomValide() { return !empty($this->_nom); } } // ...
www.siteduzero.com
64/333
Une fois que nous avons un personnage, que se passera-t-il ? Il faut en effet cacher ce formulaire et laisser place d'autres informations. Je vous propose d'afficher, dans un premier temps, les informations du personnage slectionn (son nom et ses dgts), puis, dans un second temps, la liste des autres personnages avec leurs informations. Il devra tre possible de cliquer sur le nom du personnage pour le frapper. Code : PHP <?php // On enregistre notre autoload. function chargerClasse($classname) { require $classname.'.class.php'; } spl_autoload_register('chargerClasse'); $db = new PDO('mysql:host=localhost;dbname=combats', 'root', ''); $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_WARNING); // On met une alerte chaque fois qu'une requte a chou. $manager = new PersonnagesManager($db); if (isset($_POST['creer']) && isset($_POST['nom'])) // Si on a voulu crer un personnage. { $perso = new Personnage(array('nom' => $_POST['nom'])); // On cre un nouveau personnage. if (!$perso->nomValide()) { $message = 'Le nom choisi est invalide.'; unset($perso); } elseif ($manager->exists($perso->nom())) { $message = 'Le nom du personnage est dj pris.'; unset($perso); } else { $manager->add($perso); }
elseif (isset($_POST['utiliser']) && isset($_POST['nom'])) // Si on a voulu utiliser un personnage. { if ($manager->exists($_POST['nom'])) // Si celui-ci existe. { $perso = $manager->get($_POST['nom']); } else { $message = 'Ce personnage n\'existe pas !'; // S'il n'existe pas, on affichera ce message. } } ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr"> <head> <title>TP : Mini jeu de combat</title> <meta http-equiv="Content-type" content="text/html; charset=iso8859-1" />
www.siteduzero.com
65/333
Maintenant, quelque chose devrait vous titiller. En effet, si on recharge la page, on atterrira nouveau sur le formulaire. Nous allons donc devoir utiliser le systme de sessions . La premire chose faire sera alors de dmarrer la session au dbut du script, juste aprs la dclaration de l'autoload . La session dmarre, nous pouvons aisment sauvegarder notre personnage. Pour cela, il nous faudra enregistrer le personnage en session (admettons dans $_SESSION['perso']) tout la fin du code. Cela nous permettra, au dbut du script, de rcuprer le personnage sauvegard et de continuer le jeu.
www.siteduzero.com
66/333
Pour des raisons pratiques, il est prfrable d'ajouter un lien de dconnexion pour qu'on puisse utiliser un autre personnage si on le souhaite. Ce lien aura pour effet de conduire un session_destroy().
Code : PHP <?php // On enregistre notre autoload. function chargerClasse($classname) { require $classname.'.class.php'; } spl_autoload_register('chargerClasse'); session_start(); // On appelle session_start() APRS avoir enregistr l'autoload. if (isset($_GET['deconnexion'])) { session_destroy(); header('Location: .'); exit(); } if (isset($_SESSION['perso'])) // Si la session perso existe, on restaure l'objet. { $perso = $_SESSION['perso']; } $db = new PDO('mysql:host=localhost;dbname=combats', 'root', ''); $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_WARNING); // On met une alerte chaque fois qu'une requte a chou. $manager = new PersonnagesManager($db); if (isset($_POST['creer']) && isset($_POST['nom'])) // Si on a voulu crer un personnage. { $perso = new Personnage(array('nom' => $_POST['nom'])); // On cre un nouveau personnage. if (!$perso->nomValide()) { $message = 'Le nom choisi est invalide.'; unset($perso); } elseif ($manager->exists($perso->nom())) { $message = 'Le nom du personnage est dj pris.'; unset($perso); } else { $manager->add($perso); }
elseif (isset($_POST['utiliser']) && isset($_POST['nom'])) // Si on a voulu utiliser un personnage. { if ($manager->exists($_POST['nom'])) // Si celui-ci existe. { $perso = $manager->get($_POST['nom']); } else
www.siteduzero.com
67/333
www.siteduzero.com
68/333
Il reste maintenant une dernire partie dvelopper : celle qui s'occupera de frapper un personnage. Puisque nous avons dj crit tout le code faisant l'interaction entre l'attaquant et la cible, vous verrez que nous n'aurons presque rien crire. Comment doit se passer la phase de traitement ? Avant toute chose, il faut bien vrifier que le joueur est connect et que la variable $perso existe, sinon nous n'iront pas bien loin. Seconde vrification : il faut demander notre manager si le personnage que l'on veut frapper existe bien. Si ces deux conditions sont vrifies, alors on peut lancer l'attaque. Pour lancer l'attaque, il va falloir rcuprer le personnage frapper grce notre manager. Ensuite, il suffira d'invoquer la mthode permettant de frapper le personnage. Cependant, nous n'allons pas nous arrter l. N'oubliez pas que cette mthode peut retourner 3 valeurs diffrentes : Personnage::CEST_MOI. Le personnage a voulu se frapper lui-mme. Personnage::PERSONNAGE_FRAPPE. Le personnage a bien t frapp. Personnage::PERSONNAGE_TUE. Le personnage a t tu. Il va donc falloir afficher un message en fonction de cette valeur retourne. Aussi, seuls 2 de ces cas ncessitent une mise jour de la BDD : si le personnage a t frapp ou s'il a t tu. En effet, si on a voulu se frapper soi-mme, aucun des deux personnages impliqus n'a t modifi. Code : PHP <?php // On enregistre notre autoload. function chargerClasse($classname) { require $classname.'.class.php'; } spl_autoload_register('chargerClasse'); session_start(); // On appelle session_start() APRS avoir enregistr l'autoload. if (isset($_GET['deconnexion'])) { session_destroy(); header('Location: .'); exit(); } $db = new PDO('mysql:host=localhost;dbname=combats', 'root', ''); $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_WARNING); // On met une alerte chaque fois qu'une requte a chou. $manager = new PersonnagesManager($db); if (isset($_SESSION['perso'])) // Si la session perso existe, on restaure l'objet.
www.siteduzero.com
69/333
if (isset($_POST['creer']) && isset($_POST['nom'])) // Si on a voulu crer un personnage. { $perso = new Personnage(array('nom' => $_POST['nom'])); // On cre un nouveau personnage. if (!$perso->nomValide()) { $message = 'Le nom choisi est invalide.'; unset($perso); } elseif ($manager->exists($perso->nom())) { $message = 'Le nom du personnage est dj pris.'; unset($perso); } else { $manager->add($perso); }
elseif (isset($_POST['utiliser']) && isset($_POST['nom'])) // Si on a voulu utiliser un personnage. { if ($manager->exists($_POST['nom'])) // Si celui-ci existe. { $perso = $manager->get($_POST['nom']); } else { $message = 'Ce personnage n\'existe pas !'; // S'il n'existe pas, on affichera ce message. } } elseif (isset($_GET['frapper'])) // Si on a cliqu sur un personnage pour le frapper. { if (!isset($perso)) { $message = 'Merci de crer un personnage ou de vous identifier.'; } else { if (!$manager->exists((int) $_GET['frapper'])) { $message = 'Le personnage que vous voulez frapper n\'existe pas !'; } else { $persoAFrapper = $manager->get((int) $_GET['frapper']); $retour = $perso->frapper($persoAFrapper); // On stocke dans $retour les ventuelles erreurs ou messages que renvoie la mthode frapper. switch ($retour) { case Personnage::CEST_MOI : $message = 'Mais... pourquoi voulez-vous vous frapper ???
';
www.siteduzero.com
70/333
} ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr"> <head> <title>TP : Mini jeu de combat</title> <meta http-equiv="Content-type" content="text/html; charset=iso8859-1" /> </head> <body> <p>Nombre de personnages crs : <?php echo $manager->count(); ? ></p> <?php if (isset($message)) // On a un message afficher ? { echo '<p>', $message, '</p>'; // Si oui, on l'affiche. } if (isset($perso)) // Si on utilise un personnage (nouveau ou pas). { ?> <p><a href="?deconnexion=1">Dconnexion</a></p> <fieldset> <legend>Mes informations</legend> <p> Nom : <?php echo htmlspecialchars($perso->nom()); ?><br /> Dgts : <?php echo $perso->degats(); ?> </p> </fieldset> <fieldset> <legend>Qui frapper ?</legend> <p> <?php $persos = $manager->getList($perso->nom()); if (empty($persos)) { echo 'Personne frapper !'; } else { foreach ($persos as $unPerso) { echo '<a href="?frapper=', $unPerso->id(), '">', htmlspecialchars($unPerso->nom()), '</a> (dgts : ', $unPerso-
www.siteduzero.com
71/333
Amliorations possibles
Ce code est trs basique, beaucoup d'amliorations sont possibles. En voici quelques unes : Un systme de niveau. V ous pourriez trs bien assigner chaque personnage un niveau de 1 100. Le personnage bnficierait aussi d'une exprience allant de 0 100. Lorsque l'exprience atteint 100, le personnage passe au niveau suivant. Indice : le niveau et l'exprience deviendraient des caractristiques du personnage, donc... Pas besoin de vous le dire, je suis sr que vous savez ce que a signifie ! Un systme de force. La force du personnage pourrait augmenter en fonction de son niveau, et les dgts infligs la victime seront donc plus importants. Indice : de mme, la force du personnage serait aussi une caractristique du personnage. Un systme de limitation. En effet, un personnage peut en frapper autant qu'il veut dans un laps de temps indfini. Pourquoi ne pas le limiter 3 coups par jour ? Indice : il faudrait que vous stockiez le nombre de coups ports par le personnage, ainsi que la date du dernier coup port. Cela ferait donc deux nouveaux champs en BDD, et deux nouvelles caractristiques pour le personnage ! Un systme de retrait de dgts . Chaque jour, si l'utilisateur se connecte, il pourrait voir ses dgts se soustraire de 10 par exemple. Indice : il faudrait stocker la date de dernire connexion. chaque connexion, vous regarderiez cette date. Si elle est infrieure 24h, alors vous ne feriez rien. Sinon, vous retireriez 10 de dgts au personnage puis mettriez jour cette date de dernire connexion.
www.siteduzero.com
72/333
Et la liste peut tre longue ! Je vous encourage vivement essayer d'implmenter ces fonctionnalits et laisser libre court votre imagination, vous progresserez bien plus.
www.siteduzero.com
73/333
L'hritage
L'hritage en POO (que ce soit en C++, Java ou autre langage utilisant la POO) est une technique trs puissante et extrmement pratique. Ce chapitre sur l'hritage est le chapitre connaitre par cur (ou du moins, le mieux possible). Pour tre bien sr que vous ayez compris le principe, un TP vous attend au prochain chapitre. Allez, j'arrte de vous mettre la pression, allons-y !
Lorsqu'on dit que la classe B hrite de la classe A, c'est que la classe B hrite de tous les attributs et mthodes de la classe A. Si l'on dclare des mthodes dans la classe A, et qu'on cre une instance de la classe B, alors on pourra appeler n'importe quelle mthode dclare dans la classe A du moment qu'elle est publique. Schmatiquement, une classe B hritant d'une classe A peut tre reprsente comme ceci (figure suivante).
d'une classe Personnage V ous voyez que la classe Magicien a hrit de toutes les mthodes et d'aucun attribut de la classe Personnage. Souvenezvous : toutes les mthodes sont publiques et tous les attributs sont privs. En fait, les attributs privs ont bien t hrits aussi,
www.siteduzero.com
74/333
mais notre classe Magicien ne pourra s'en servir, c'est la raison pour laquelle je ne les ai pas reprsents. Il n'y a que les mthodes de la classe parente qui auront accs ces attributs. C'est comme pour le principe d'encapsulation : ici, les lments privs sont masqus . On dit que la classe Personnage est la classe mre et que la classe Magicien est la classe fille. Je n'ai pas mis toutes les mthodes du dernier TP dans ce schma pour ne pas le surcharger, mais en ralit, toutes les mthodes ont bien t hrites.
Quand est-ce que je sais si telle classe doit hriter d'une autre ?
Soit deux classes A et B. Pour qu'un hritage soit possible, il faut que vous puissiez dire que A est un B. Par exemple, un magicien est un personnage, donc hritage. Un chien est un animal, donc hritage aussi. Bref, vous avez compris le principe.
Procder un hritage
Pour procder un hritage (c'est--dire faire en sorte qu'une classe hrite des attributs et mthodes d'une autre classe), il suffit d'utiliser le mot-cl extends. V ous dclarez votre classe comme d'habitude (class MaClasse) en ajoutant extends NomDeLaClasseAHeriter comme ceci : Code : PHP <?php class Personnage // Cration d'une classe simple. { } class Magicien extends Personnage // Notre classe Magicien hrite des attributs et mthodes de Personnage. { } ?>
Comme dans la ralit, une mre peut avoir plusieurs filles, mais une fille ne peut avoir plusieurs mres. La seule diffrence avec la vie relle, c'est qu'une mre ne peut avoir une infinit de filles. Ainsi, on pourrait crer des classes Magicien, Guerrier, Brute, etc. qui hritent toutes de Personnage : la classe Personnage sert de modle. Code : PHP <?php class Personnage // Cration d'une classe simple. { } // Toutes les classes suivantes hriteront de Personnage. class Magicien extends Personnage { } class Guerrier extends Personnage { } class Brute extends Personnage
www.siteduzero.com
75/333
Ainsi, toutes ces nouvelles classes auront les mmes attributs et mthodes que Personnage. Super, tu me cres des classes qui sont exactement les mmes qu'une autre Trs utile ! En plus, tout ce qui est priv je n'y ai pas accs donc
Nous sommes d'accord, si l'hritage c'tait a, ce serait le concept le plus idiot et le plus inutile de la POO. Chaque classe peut crer des attributs et mthodes qui lui seront propres , et c'est l toute la puissance de l'hritage : toutes les classes que l'on a cres plus haut peuvent avoir des attributs et mthodes en plus des attributs et mthodes hrits. Pour cela, rien de plus simple. Il vous suffit de crer des attributs et mthodes comme nous avons appris jusqu' maintenant. Un exemple ? Code : PHP <?php class Magicien extends Personnage { private $_magie; // Indique la puissance du magicien sur 100, sa capacit produire de la magie. public function lancerUnSort($perso) { $perso->recevoirDegats($this->_magie); // On va dire que la magie du magicien reprsente sa force. } } ?>
Ainsi, la classe Magicien aura, en plus des attributs et mthodes hrits , un attribut $magie et une mthode lancerUnSort. Si vous essayez d'accder un attribut priv de la classe parente, aucune erreur fatale ne s'affichera, seulement une notice si vous les avez actives disant que l'attribut n'existe pas.
www.siteduzero.com
76/333
<?php class Magicien extends Personnage { private $_magie; // Indique la puissance du magicien sur 100, sa capacit produire de la magie. public function lancerUnSort($perso) { $perso->recevoirDegats($this->_magie); // On va dire que la magie du magicien reprsente sa force. } public function gagnerExperience() { // On appelle la mthode gagnerExperience() de la classe parente parent::gagnerExperience(); if ($this->_magie < 100) { $this->_magie += 10; }
} ?>
Notez que si la mthode parente retourne une valeur, vous pouvez la rcuprer comme si vous appeliez une mthode normalement. Exemple : Code : PHP <?php class A { public function test() { return 'test'; } } class B extends A { public function test() { $retour = parent::test(); } echo $retour; // Affiche 'test'
Comme vous pouvez le constater, j'ai fait appel aux getters et setters correspondant l'attribut $_magie. Pourquoi ? Car les classes enfant n'ont pas accs aux lments privs, il fallait donc que la classe parente le fasse pour moi ! Il n'y a que les mthodes de la classe parente non rcrites qui ont accs aux lments privs. partir du moment o l'on rcrit une mthode de la classe parente, la mthode appartient la classe fille et n'a donc plus accs aux lments privs. Si vous surchargez une mthode, sa visibilit doit tre la mme que dans la classe parente ! Si tel n'est pas le cas, une erreur fatale sera leve. Par exemple, vous ne pouvez surcharger une mthode publique en disant qu'elle est prive.
Hritez l'infini !
www.siteduzero.com
77/333
Toute classe en POO peut tre hrite si elle ne spcifie pas le contraire, vraiment toutes . V ous pouvez ainsi reproduire un arbre rel avec autant de classes hritant les unes des autres que vous le souhaitez. Pour reprendre l'exemple du magicien dans le cours sur la POO en C++ de M@teo21, on peut crer deux autres classes MagicienBlanc et MagicienNoir qui hritent toutes les deux de Magicien. Exemple : Code : PHP <?php class Personnage // Classe Personnage de base. { } class Magicien extends Personnage // Classe Magicien hritant de Personnage. { } class MagicienBlanc extends Magicien // Classe MagicienBlanc hritant de Magicien. { } class MagicienNoir extends Magicien // Classe MagicienNoir hritant de Magicien. { } ?>
www.siteduzero.com
78/333
Exemple
d'un hritage multiple Ainsi, les classes MagicienBlanc et MagicienNoir hriteront de tous les attributs et de toutes les mthodes des classes Magicien et Personnage.
Le type de visibilit protected est en fait une petite modification du type private : il a exactement les mmes effets que private, l'exception que toute classe fille aura accs aux lments protgs. Exemple : Code : PHP <?php class ClasseMere { protected $attributProtege; private $_attributPrive; public function __construct()
www.siteduzero.com
79/333
class ClasseFille extends ClasseMere { public function afficherAttributs() { echo $this->attributProtege; // L'attribut est protg, on a donc accs celui-ci. echo $this->_atributPrive; // L'attribut est priv, on n'a pas accs celui-ci, donc rien ne s'affichera (mis part une notice si vous les avez actives). } } $obj = new ClasseFille; echo $obj->attributProtege; // Erreur fatale. echo $obj->_attributPrive; // Rien ne s'affiche (ou une notice si vous les avez actives). $obj->afficherAttributs(); // Affiche Hello world ! suivi de rien du tout ou d'une notice si vous les avez actives. ?>
Comme vous pouvez le constater, il n'y a pas d'underscores prcdant les noms d'lments protgs. C'est encore une fois la notation PEAR qui nous dit que les noms d'lments protgs ne sont pas protgs de ce caractre. Et pour le principe d'encapsulation, j'utilise quoi ? private ou protected ?
La porte private est, selon moi, bien trop restrictive et contraignante. Elle empche toute classe enfant d'accder aux attributs et mthodes prives alors que cette dernire en a souvent besoin. De manire gnrale, je vous conseille donc de toujours mettre protected au lieu de private, moins que vous teniez absolument ce que la classe enfant ne puisse y avoir accs. Cependant, je trouve cela inutile dans le sens o la classe enfant a t cre par un dveloppeur, donc quelqu'un qui sait ce qu'il fait et qui par consquent doit pouvoir modifier souhait tous les attributs, contrairement l'utilisateur de la classe.
Abstraction
Classes abstraites
On a vu jusqu' maintenant que l'on pouvait instancier n'importe quelle classe afin de pouvoir exploiter ses mthodes. On va maintenant dcouvrir comment empcher quiconque d' instancier telle classe. Mais quoi a sert de crer une classe si on ne peut pas s'en servir ?
On ne pourra pas se servir directement de la classe. La seule faon d'exploiter ses mthodes est de crer une classe hritant de la classe abstraite. V ous vous demandez sans doute quoi cela peut bien servir. L'exemple que je vais prendre est celui du personnage et de ses classes filles. Dans ce que nous venons de faire, nous ne crerons jamais d'objet Personnage, mais uniquement des objets Magicien, Guerrier, Brute, etc. En effet, quoi cela nous servirait d'instancier la classe Personnage si notre but est de crer un tel type de personnage ?
www.siteduzero.com
80/333
Simple et court retenir, il suffit juste de se souvenir o l'on doit le placer. Ainsi, si vous essayez de crer une instance de la classe Personnage, une erreur fatale sera leve. Ceci nous garantit que l'on ne crera jamais d'objet Personnage (suite une tourderie par exemple).
Mthodes abstraites
Si vous dcidez de rendre une mthode abstraite en plaant le mot-cl abstract juste avant la visibilit de la mthode, vous forcerez toutes les classes filles crire cette mthode. Si tel n'est pas le cas, une erreur fatale sera leve. Puisque l'on force la classe fille crire la mthode, on ne doit spcifier aucune instruction dans la mthode, on dclarera juste son prototype (visibilit + function + nomDeLaMethode + parenthses avec ou sans paramtres + point-virgule). Code : PHP <?php abstract class Personnage { // On va forcer toute classe fille crire cette mthode car chaque personnage frappe diffremment. abstract public function frapper(Personnage $perso); // Cette mthode n'aura pas besoin d'tre rcrite. public function recevoirDegats() { // Instructions. }
class Magicien extends Personnage { // On crit la mthode frapper du mme type de visibilit que la mthode abstraite frapper de la classe mre. public function frapper(Personnage $perso) { // Instructions. } } ?>
www.siteduzero.com
81/333
Pour dfinir une mthode comme tant abstraite, il faut que la classe elle-mme soit abstraite !
Finalisation
Classes finales
Le concept des classes et mthodes finales est exactement l'inverse du concept d'abstraction. Si une classe est finale, vous ne pourrez pas crer de classe fille hritant de cette classe. Pour ma part, je ne rends jamais mes classes finales (au mme titre que, quelques exceptions prs, je mets toujours mes attributs en protected) pour me laisser la libert d'hriter de n'importe quelle classe. Pour dclarer une classe finale, vous devez placer le mot-cl final juste avant le mot-cl class, comme abstract. Code : PHP <?php // Classe abstraite servant de modle. abstract class Personnage { } // Classe finale, on ne pourra crer de classe hritant de Guerrier. final class Guerrier extends Personnage { } // Erreur fatale, car notre classe hrite d'une classe finale. class GentilGuerrier extends Guerrier { } ?>
Mthodes finales
Si vous dclarez une mthode finale, toute classe fille de la classe comportant cette mthode finale hritera de cette mthode mais ne pourra la surcharger. Si vous dclarez votre mthode recevoirDegats en tant que mthode finale, vous ne pourrez la surcharger. Code : PHP <?php abstract class Personnage { // Mthode normale. public function frapper(Personnage $perso) { // Instructions. }
www.siteduzero.com
82/333
class Guerrier extends Personnage { // Aucun problme. public function frapper(Personnage $perso) { // Instructions. } // Erreur fatale car cette mthode est finale dans la classe parente. public function recevoirDegats() { // Instructions. }
} ?>
Cette sous-partie va vous montrer une possibilit intressante de la POO en PHP : la rsolution statique la vole. C'est une notion un peu complexe comprendre au premier abord donc n'hsitez pas relire cette partie autant de fois que ncessaire. Effectuons d'abord un petit flash-back sur self::. V ous vous souvenez quoi il sert ? appeler un attribut, une mthode statique ou une constante de la classe dans laquelle est contenu self::. Ainsi, si vous testez ce code : Code : PHP <?php class Mere { public static function lancerLeTest() { self::quiEstCe(); } public function quiEstCe() { echo 'Je suis la classe <strong>Mere</strong> !'; }
class Enfant extends Mere { public function quiEstCe() { echo 'Je suis la classe <strong>Enfant</strong> !'; } } Enfant::lancerLeTest(); ?>
www.siteduzero.com
83/333
le script
Appel de la mthode lancerLeTest de la classe Enfant ; la mthode n'a pas t rcrite, on va donc chercher la mthode lancerLeTest de la classe mre ; appel de la mthode quiEstCe de la classe Mere.
Pourquoi c'est la mthode quiEstCe de la classe parente qui a t appele ? Pourquoi pas celle de la classe fille puisqu'elle a t rcrite ?
Tout simplement parce que self:: fait appel la mthode statique de la classe dans laquelle est contenu self::, donc de la classe parente. Et la rsolution statique la vole dans tout a ?
Tout tourne autour de l'utilisation de static::. static:: a exactement le mme effet que self::, l'exception prs que static:: appelle l'lment de la classe qui est appele pendant l'excution. C'est--dire que si j'appelle la mthode lancerLeTest depuis la classe Enfant et que dans cette mthode j'utilise static:: au lieu de self::, c'est la mthode quiEstCe de la classe Enfant qui sera appele et non de la classe Mere ! Code : PHP <?php class Mere { public static function lancerLeTest() { static::quiEstCe(); } public function quiEstCe() { echo 'Je suis la classe <strong>Mere</strong> !'; }
www.siteduzero.com
84/333
Enfant::lancerLeTest(); ?>
Ce qui donnera :
le script
Notez que tous les exemples ci-dessus utilisent des mthodes qui sont appeles dans un contexte statique. J'ai fait ce choix car pour ce genre de tests, il tait inutile d'instancier la classe, mais sachez bien que la rsolution statique la vole a exactement le mme effet quand on cre un objet puis qu'on appelle une mthode de celui-ci. Il n'est donc pas du tout obligatoire de rendre les mthodes statiques pour pouvoir y placer static::. Ainsi, si vous testez ce code, l'cran s'affichera la mme chose que prcdemment.
Code : PHP <?php class Mere { public function lancerLeTest() { static::quiEstCe(); } public function quiEstCe() { echo 'Je suis la classe Mere !'; }
class Enfant extends Mere { public function quiEstCe() { echo 'Je suis la classe Enfant !'; } } $e = new Enfant; $e->lancerLeTest(); ?>
www.siteduzero.com
85/333
Cas complexes
Au premier abord, vous n'avez peut-tre pas tout compris. Si tel est le cas, ne lisez pas la suite cela risquerait de vous embrouiller davantage. Prenez bien le temps de comprendre ce qui est crit plus haut puis vous pourrez continuer. Comme le spcifie le titre, il y a quelques cas complexes (des piges en quelque sorte). Imaginons trois classes A, B et C qui hritent chacune d'une autre (A est la grand-mre, B la mre et C la fille ). En PHP, on dirait plutt : Code : PHP <?php class A { } class B extends A { } class C extends B { } ?>
Nous allons implmenter dans chacune des classes une mthode qui aura pour rle d'afficher le nom de la classe pour pouvoir effectuer quelques tests. Code : PHP <?php class A { public function quiEstCe() { echo 'A'; } } class B extends A { public function quiEstCe() { echo 'B'; } } class C extends B { public function quiEstCe() { echo 'C'; } } ?>
Crons une mthode de test dans la classe B. Pourquoi dans cette classe ? Parce qu'elle hrite la fois de A et est hrite par C,
www.siteduzero.com
86/333
Appelons maintenant cette mthode depuis la classe C dans un contexte statique (nul besoin de crer d'objet, mais a marche tout aussi bien ). Code : PHP <?php class A { public function quiEstCe() { echo 'A'; } } class B extends A { public static function test() { } public function quiEstCe() { echo 'B'; }
Plaons un peu de code dans cette mthode, sinon c'est pas drle. Nous allons essayer d'appeler la mthode parente quiEstCe. L, il n'y a pas de pige, pas de rsolution statique la vole, donc l'cran s'affichera A : Code : PHP <?php class A { public function quiEstCe() { echo 'A'; } } class B extends A { public static function test() { parent::quiEstCe(); } public function quiEstCe()
www.siteduzero.com
87/333
Maintenant, crons une mthode dans la classe A qui sera charge d'appeler la mthode quiEstCe avec static::. L, si vous savez ce qui va s'afficher, vous avez tout compris ! Code : PHP <?php class A { public function appelerQuiEstCe() { static::quiEstCe(); } public function quiEstCe() { echo 'A'; }
class B extends A { public static function test() { parent::appelerQuiEstCe(); } public function quiEstCe() { echo 'B'; }
Alors ? V ous avez une petite ide ? l'cran s'affichera C ! Dcortiquons ce qui s'est pass : Appel de la mthode test de la classe C ;
www.siteduzero.com
88/333
la mthode n'a pas t rcrite, on appelle donc la mthode test de la classe B ; on appelle maintenant la mthode appelerQuiEstCe de la classe A (avec parent::) ; rsolution statique la vole : on appelle la mthode quiEstCe de la classe qui a appel la mthode appelerQuiEstCe ; la mthode quiEstCe de la classe C est donc appele car c'est depuis la classe C qu'on a appel la mthode test.
C'est trs compliqu mais fondamental comprendre. Remplaons maintenant parent:: par self:: : Code : PHP <?php class A { public function appelerQuiEstCe() { static::quiEstCe(); } public function quiEstCe() { echo 'A'; }
class B extends A { public static function test() { self::appelerQuiEstCe(); } public function quiEstCe() { echo 'B'; }
Et l, qu'est-ce qui s'affiche l'cran ? Et bien toujours C ! Le principe est exactement le mme que le code plus haut. Si vous cassez la chane en appelant une mthode depuis une instance ou statiquement du genre Classe::methode(), la mthode appele par static:: sera celle de la classe contenant ce code ! Ainsi, le code suivant affichera A .
www.siteduzero.com
89/333
class B extends A { public static function test() { // On appelle appelerQuiEstCe de la classe A normalement. A::appelerQuiEstCe(); } public function quiEstCe() { echo 'B'; }
www.siteduzero.com
90/333
l'cran s'affichera TestChild suivi de TestParent . Je vous explique ce qui s'est pass si vous n'avez pas tout suivi : Cration d'une instance de la classe TestChild ; appel de la mthode qui de la classe TestChild puisque c'est la mthode __construct de la classe TestChild qui a t appele ; appel de la mthode test de la classe TestChild ; cration d'une instance de la classe TestParent ; appel de la mthode qui de la classe TestParent puisque c'est la mthode __construct de cette classe qui a t appele. Ouf ! Enfin termin ! N'hsitez pas le relire autant de fois que ncessaire afin de bien comprendre cette notion d'hritage et toutes les possibilits que ce concept vous offre. Ne soyez pas presss de continuer si vous n'avez pas tout compris, sinon vous allez vous planter au TP.
En rsum
Nous pouvons parler d'hritage entre une classe A et une classe B si et seulement si nous pouvons dire B est un A (dans ce cas-l, B hrite de A). Une classe hritant d'une autre a accs tous ses attributs et mthodes publics ou protgs. La visibilit protected est quivalente la visibilit private la diffrence prs qu'un lment protg est accessible par les classes filles, contrairement aux lments privs. Il est possible d'interdire l'instanciation d'une classe grce au mot-cl abstract (utile pour poser un modle de base commun plusieurs classes) et l'hritage d'une classe grce au mot-cl final. Il est possible d'obliger ses classes filles implmenter une mthode grce au mot-cl abstract et de leur interdire la rcriture d'une mthode grce au mot-cl final. La rsolution statique la vole permet de savoir quelle classe a t initialement appele pour invoquer la mthode dans laquelle on se trouve.
www.siteduzero.com
91/333
Je ne mettrai pas en pratique la rsolution statique la vole car elle ne nous est pas utile ici. Aussi, la finalisation n'est pas utilise car c'est davantage une contrainte inutile qu'autre chose dans cette situation.
Ceci n'est qu'une petite liste de dpart. Libre vous de crer d'autres personnages. Comme vous le voyez, chaque personnage possde un atout. Cet atout devra tre augment lorsque le personnage est amen s'en servir (c'est--dire lorsque le magicien lance un sort ou que le guerrier subit des dgts).
La base de donnes
La structure de la BDD ne sera pas la mme. En effet, chaque personnage aura un attribut en plus, et surtout, il faut savoir de quel personnage il s'agit (magicien ou guerrier). Nous allons donc crer une colonne type et une colonne atout (l'attribut qu'il a en plus). Une colonne timeEndormi devra aussi tre cre pour stocker le timestamp auquel le personnage se rveillera s'il a t ensorcel. Je vous propose donc cette nouvelle structure (j'ai juste ajout trois nouveaux champs en fin de table) : Code : SQL CREATE TABLE IF NOT EXISTS `personnages_v2` ( `id` smallint(5) unsigned NOT NULL AUTO_INCREMENT, `nom` varchar(50) COLLATE latin1_general_ci NOT NULL,
www.siteduzero.com
92/333
Le personnage
L o il y a peut-tre une difficult, c'est pour dterminer l'attribut $type. En effet, o doit-on assigner cette valeur ? Qui doit le faire ? Pour des raisons videntes de risques de bugs, ce ne sera pas l'utilisateur d'assigner la valeur guerrier ou magicien cet attribut, mais la classe elle-mme. Cependant, il serait redondant dans chaque classe fille de Personnage de faire un <?php $this->type = 'magicien' par exemple, alors on va le faire une bonne fois pour toute dans la classe Personnage. Comment cela est-il possible ?
Grce une fonction bien pratique (nomme get_class()), il est possible d'obtenir le nom d'une classe partir d'une instance de cette classe. Par exemple, si on instancie une classe Guerrier, alors get_class($instance) renverra Guerrier . Ici, nous nous situons dans le constructeur de la classe Personnage : l'instance du personnage sera donc reprsente par... $this ! Eh oui, get_class($this), dans le constructeur de Personnage, ne renverra pas Personnage , mais Guerrier ou Magicien . Pourquoi ? Car get_class() ne renvoie pas le nom de la classe dans laquelle elle est appele, mais le nom de la classe instancie par l'objet pass en argument. Or, l'instance $this n'est autre qu'une instance de Guerrier ou Magicien. Pour des raisons pratiques, le type du personnage doit tre en minuscules. Un petit appel strtolower() sera donc indispensable.
Le magicien
Qui dit nouvelle fonctionnalit dit nouvelle mthode. V otre classe Magicien devra donc implmenter une nouvelle mthode permettant de lancer un sort. Celle-ci devra vrifier plusieurs points : La cible ensorceler n'est pas le magicien qui lance le sort. Le magicien possde encore de la magie (l'atout n'est pas 0).
Le guerrier
Ce qu'on cherche faire ici est modifier le comportement du personnage lorsqu'il subit des dgts. Nous allons donc modifier la mthode qui se charge d'ajouter des dgts au personnage. Cette mthode procdera de la sorte : Elle calculera d'abord la valeur de l'atout. Elle augmentera les dgts en prenant soin de prendre en compte l'atout. Elle indiquera si le personnage a t frapp ou tu.
Tu nous parles d'un atout depuis tout l'heure, mais comment est-ce qu'on le dtermine ?
www.siteduzero.com
93/333
L'atout du magicien et du guerrier se dterminent de la mme faon : Si les dgts sont compris Si les dgts sont compris Si les dgts sont compris Si les dgts sont compris Sinon, il sera de 0. entre 0 et 25, alors l'atout sera de 4. entre 25 et 50, alors l'atout sera de 3. entre 50 et 75, alors l'atout sera de 2. entre 75 et 90, alors l'atout sera de 1.
Du ct du guerrier, j'utilise une simple formule : la dose de dgts reu ne sera pas de 5, mais de 5 - $atout. Du ct du magicien, l aussi j'utilise une simple formule : il endort sa victime pendant ($this->atout * 6) * 3600 secondes.
Correction
Nous allons maintenant corriger le TP. Les codes seront d'abord prcds d'explications pour bien mettre au clair ce qui tait demand. Commenons d'abord par notre classe Personnage. Celle-ci devait implmenter deux nouvelles mthodes (sans compter les getters et setters) : estEndormi() et reveil(). Aussi il ne fallait pas oublier de modifier la mthode frapper() afin de bien vrifier que le personnage qui frappe n'tait pas endormi ! Enfin, il fallait assigner la bonne valeur l'attribut $type dans le constructeur. Il ne fallait pas mettre de setter pour l'attribut $type. En effet, le type d'un personnage est constant (un magicien ne se transforme pas en guerrier). Il est dfini dans le constructeur et l'utilisateur ne pourra pas changer sa valeur (imaginez le non-sens qu'il y aurait si l'utilisateur mettait magicien l'attribut $type d'un objet Guerrier).
Code : PHP - Personnage.class.php <?php abstract class Personnage { protected $atout, $degats, $id, $nom, $timeEndormi, $type; const CEST_MOI = 1; // Constante renvoye par la mthode `frapper` si on se frappe soit-mme. const PERSONNAGE_TUE = 2; // Constante renvoye par la mthode `frapper` si on a tu le personnage en le frappant. const PERSONNAGE_FRAPPE = 3; // Constante renvoye par la mthode `frapper` si on a bien frapp le personnage. const PERSONNAGE_ENSORCELE = 4; // Constante renvoye par la mthode `lancerUnSort` (voir classe Magicien) si on a bien ensorcel un personnage. const PAS_DE_MAGIE = 5; // Constante renvoye par la mthode `lancerUnSort` (voir classe Magicien) si on veut jeter un sort alors que la magie du magicien est 0. const PERSO_ENDORMI = 6; // Constante renvoye par la mthode `frapper` si le personnage qui veut frapper est endormi. public function __construct(array $donnees) { $this->hydrate($donnees); $this->type = strtolower(get_class($this)); }
www.siteduzero.com
94/333
public function nomValide() { return !empty($this->nom); } public function recevoirDegats($force) { $this->degats += 5; // Si on a 100 de dgts ou plus, on supprime le personnage de la BDD. if ($this->degats >= 100) { return self::PERSONNAGE_TUE; } // Sinon, on se contente de mettre jour les dgts du personnage. return self::PERSONNAGE_FRAPPE; } public function reveil() { $secondes = $this->timeEndormi; $secondes -= time(); $heures = floor($secondes / 3600); $secondes -= $heures * 3600; $minutes = floor($secondes / 60); $secondes -= $minutes * 60; $heures .= $heures <= 1 ? ' heure' : ' heures'; $minutes .= $minutes <= 1 ? ' minute' : ' minutes';
www.siteduzero.com
95/333
public function atout() { return $this->atout; } public function degats() { return $this->degats; } public function id() { return $this->id; } public function nom() { return $this->nom; } public function timeEndormi() { return $this->timeEndormi; } public function type() { return $this->type; } public function setAtout($atout) { $atout = (int) $atout; if ($atout >= 0 && $atout <= 100) { $this->atout = $atout; }
public function setDegats($degats) { $degats = (int) $degats; if ($degats >= 0 && $degats <= 100) { $this->degats = $degats; }
public function setId($id) { $id = (int) $id; if ($id > 0) { $this->id = $id; }
www.siteduzero.com
96/333
Penchons-nous maintenant vers la classe Guerrier. Celle-ci devait modifier la mthode recevoirDegats() afin d'ajouter une parade lors d'une attaque. Code : PHP - Guerrier.class.php <?php class Guerrier extends Personnage { public function recevoirDegats($force) { if ($this->degats >= 0 && $this->degats <= 25) { $this->atout = 4; } elseif ($this->degats > 25 && $this->degats <= 50) { $this->atout = 3; } elseif ($this->degats > 50 && $this->degats <= 75) { $this->atout = 2; } elseif ($this->degats > 50 && $this->degats <= 90) { $this->atout = 1; } else { $this->atout = 0; } $this->degats += 5 - $this->atout; // Si on a 100 de dgts ou plus, on supprime le personnage de la BDD. if ($this->degats >= 100) { return self::PERSONNAGE_TUE; } // Sinon, on se contente de mettre jour les dgts du personnage. return self::PERSONNAGE_FRAPPE; } }
Enfin, il faut maintenant s'occuper du magicien. La classe le reprsentant devait ajouter une nouvelle fonctionnalit : celle de pouvoir lancer un sort. Code : PHP - Magicien.class.php <?php class Magicien extends Personnage {
www.siteduzero.com
97/333
Passons maintenant au manager. Nous allons toujours garder un seul manager parce que nous grons toujours des personnages ayant la mme structure. Les modifications sont mineures : il faut juste ajouter les deux nouveaux champs dans les requtes et instancier la bonne classe lorsqu'on rcupre un personnage. Code : PHP - PersonnagesManager.class.php <?php class PersonnagesManager { private $db; // Instance de PDO public function __construct($db) { $this->db = $db; } public function add(Personnage $perso) { $q = $this->db->prepare('INSERT INTO personnages_v2 SET nom = :nom, type = :type'); $q->bindValue(':nom', $perso->nom());
www.siteduzero.com
98/333
public function count() { return $this->db->query('SELECT COUNT(*) FROM personnages_v2')>fetchColumn(); } public function delete(Personnage $perso) { $this->db->exec('DELETE FROM personnages_v2 WHERE id = '.$perso>id()); } public function exists($info) { if (is_int($info)) // On veut voir si tel personnage ayant pour id $info existe. { return (bool) $this->db->query('SELECT COUNT(*) FROM personnages_v2 WHERE id = '.$info)->fetchColumn(); } // Sinon, c'est qu'on veut vrifier que le nom existe ou pas. $q = $this->db->prepare('SELECT COUNT(*) FROM personnages_v2 WHERE nom = :nom'); $q->execute(array(':nom' => $info)); } return (bool) $q->fetchColumn();
public function get($info) { if (is_int($info)) { $q = $this->db->query('SELECT id, nom, degats, timeEndormi, type, atout FROM personnages_v2 WHERE id = '.$info); $perso = $q->fetch(PDO::FETCH_ASSOC); } else { $q = $this->db->prepare('SELECT id, nom, degats, timeEndormi, type, atout FROM personnages_v2 WHERE nom = :nom'); $q->execute(array(':nom' => $info)); } $perso = $q->fetch(PDO::FETCH_ASSOC);
switch ($perso['type']) { case 'guerrier': return new Guerrier($perso); case 'magicien': return new Magicien($perso); default: return null; }
www.siteduzero.com
99/333
public function update(Personnage $perso) { $q = $this->db->prepare('UPDATE personnages_v2 SET degats = :degats, timeEndormi = :timeEndormi, atout = :atout WHERE id = :id'); $q->bindValue(':degats', $perso->degats(), PDO::PARAM_INT); $q->bindValue(':timeEndormi', $perso->timeEndormi(), PDO::PARAM_INT); $q->bindValue(':atout', $perso->atout(), PDO::PARAM_INT); $q->bindValue(':id', $perso->id(), PDO::PARAM_INT); } $q->execute();
Enfin, finissons par la page d'index qui a lgrement chang. Quelles sont les modifications ? Le formulaire doit proposer au joueur de choisir le type du personnage qu'il veut crer. Lorsqu'on cre un personnage, le script doit crer une instance de la classe dsire et non de Personnage. Lorsqu'on veut frapper un personnage, on vrifie que l'attaquant n'est pas endormi. Un lien permettant d'ensorceler un personnage doit tre ajout pour les magiciens ainsi que l'antidote qui va avec. Code : PHP - index.php <?php function chargerClasse($classe) { require $classe . '.class.php'; } spl_autoload_register('chargerClasse'); session_start(); if (isset($_GET['deconnexion'])) { session_destroy(); header('Location: .'); exit(); } $db = new PDO('mysql:host=localhost;dbname=combats', 'root', ''); $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_WARNING); $manager = new PersonnagesManager($db);
www.siteduzero.com
100/333
if (isset($perso)) // Si le type du personnage est valide, on a cr un personnage. { if (!$perso->nomValide()) { $message = 'Le nom choisi est invalide.'; unset($perso); } elseif ($manager->exists($perso->nom())) { $message = 'Le nom du personnage est dj pris.'; unset($perso); } else { $manager->add($perso); } } } elseif (isset($_POST['utiliser']) && isset($_POST['nom'])) // Si on a voulu utiliser un personnage. { if ($manager->exists($_POST['nom'])) // Si celui-ci existe. { $perso = $manager->get($_POST['nom']); } else { $message = 'Ce personnage n\'existe pas !'; // S'il n'existe pas, on affichera ce message. } } elseif (isset($_GET['frapper'])) // Si on a cliqu sur un personnage pour le frapper. { if (!isset($perso)) { $message = 'Merci de crer un personnage ou de vous identifier.'; } else { if (!$manager->exists((int) $_GET['frapper']))
www.siteduzero.com
101/333
';
www.siteduzero.com
102/333
???';
www.siteduzero.com
103/333
echo $perso->atout(); ?> </p> </fieldset> <fieldset> <legend>Qui attaquer ?</legend> <p> <?php // On rcupre tous les personnages par ordre alphabtique, dont le nom est diffrent de celui de notre personnage (on va pas se frapper nous-mme :p). $retourPersos = $manager->getList($perso->nom()); if (empty($retourPersos)) { echo 'Personne frapper !'; } else { if ($perso->estEndormi()) { echo 'Un magicien vous a endormi ! Vous allez vous rveiller dans ', $perso->reveil(), '.'; } else { foreach ($retourPersos as $unPerso) { echo '<a href="?frapper=', $unPerso->id(), '">', htmlspecialchars($unPerso->nom()), '</a> (dgts : ', $unPerso>degats(), ' | type : ', $unPerso->type(), ')'; // On ajoute un lien pour lancer un sort si le personnage est un magicien. if ($perso->type() == 'magicien') { echo ' | <a href="?ensorceler=', $unPerso->id(), '">Lancer un sort</a>'; } } echo '<br />';
} ?>
</p> </fieldset> <?php } else { ?> <form action="" method="post"> <p> Nom : <input type="text" name="nom" maxlength="50" /> <input type="submit" value="Utiliser ce personnage" name="utiliser" /><br /> Type : <select name="type"> <option value="magicien">Magicien</option> <option value="guerrier">Guerrier</option>
www.siteduzero.com
104/333
Alors, vous commencez comprendre toute la puissance de la POO et de l'hritage ? Avec une telle structure, vous pourrez tout moment dcider de crer un nouveau personnage trs simplement ! Il vous suffit de crer une nouvelle classe, d'ajouter le type du personnage l'numration type en BDD et de modifier un petit peu le fichier index.php et votre personnage voit le jour !
Amliorations possibles
Comme au prcdent TP, beaucoup d'amliorations sont possibles, commencer par celles dj exposes dans le chapitre dudit TP : Un systme de niveau. V ous pourriez trs bien assigner chaque personnage un niveau de 1 100. Le personnage bnficierait aussi d'une exprience allant de 0 100. Lorsque l'exprience atteint 100, le personnage passe au niveau suivant. Indice : le niveau et l'exprience deviendraient des caractristiques du personnage, donc... Pas besoin de vous le dire, je suis sr que vous savez ce que a signifie ! Un systme de force. La force du personnage pourrait augmenter en fonction de son niveau, les dgts infligs la victime seront donc plus importants. Indice : de mme, la force du personnage serait aussi une caractristique du personnage. Un systme de limitation. En effet, un personnage peut en frapper autant qu'il veut dans un laps de temps indfini. Pourquoi ne pas le limiter 3 coups par jour ? Indice : il faudrait que vous stockiez le nombre de coups ports par le personnage, ainsi que la date du dernier coup port. Cela ferait donc deux nouveaux champs en BDD, et deux nouvelles caractristiques pour le personnage ! Un systme de retrait de dgts . Chaque jour, si l'utilisateur se connecte, il pourrait voir ses dgts se soustraire de 10 par exemple. Indice : il faudrait stocker la date de dernire connexion. chaque connexion, vous regarderiez cette date. Si elle est infrieure 24h, alors vous ne feriez rien. Sinon, vous retireriez 10 de dgts au personnage puis mettriez jour cette date de dernire connexion. Pour reprendre cet esprit, vous pouvez vous entraner crer d'autres personnages, comme une brute par exemple. Son atout dpendrait aussi de ses dgts et viendrait augmenter sa force lors d'une attaque. La seule diffrence avec le premier TP est l'apparition de nouveaux personnages, les seules amliorations diffrentes possibles sont donc justement la cration de nouveaux personnages. Ainsi je vous encourage imaginer tout un tas de diffrents personnages tous aussi farfelus les uns que les autres : cela vous fera grandement progresser et cela vous aidera vous familiariser avec l'hritage !
www.siteduzero.com
105/333
Le principe
V ous devez sans doute vous poser une grande question la vue du titre du chapitre : mais qu'est-ce que c'est qu'une mthode magique ? Une mthode magique est une mthode qui, si elle est prsente dans votre classe, sera appele lors de tel ou tel vnement. Si la mthode n'existe pas et que lvnement est excut, aucun effet spcial ne sera ajout, lvnement s'excutera normalement. Le but des mthodes magiques est d'intercepter un vnement, dire de faire ceci ou cela et retourner une valeur utile pour lvnement si besoin il y a. Bonne nouvelle : vous connaissez dj une mthode magique ! Si si, cherchez bien au fond de votre tte Et oui, la mthode __construct est magique ! Comme nous l'avons vu plus haut, chaque mthode magique s'excute au moment o un vnement est lanc. Lvnement qui appelle la mthode __construct est la cration de l'objet. Dans le mme genre que __construct on peut citer __destruct qui, elle, sera appele lors de la destruction de l'objet. Assez intuitif, mais voici un exemple au cas o : Code : PHP <?php class MaClasse { public function __construct() { echo 'Construction de MaClasse'; } public function __destruct() { echo 'Destruction de MaClasse'; }
V ous avez raison, il serait d'abord prfrable d'expliquer ceci. La surcharge d'attributs ou mthodes consiste prvoir le cas o l'on appelle un attribut ou mthode qui n'existe pas ou du moins, auquel on n'a pas accs (par exemple, si un attribut ou une mthode est priv(e)). Dans ce cas-l, on a voyons 6 mthodes magiques notre disposition !
__set et __get
Commenons par tudier ces deux mthodes magiques. Leur principe est le mme, leur fonctionnement est peu prs semblable, c'est juste l'vnement qui change. Commenons par __set. Cette mthode est appele lorsque l'on essaye d'assigner une valeur un attribut auquel on n'a pas accs ou qui n'existe pas. Cette mthode prend deux paramtres : le premier est le nom de l'attribut auquel on a tent d'assigner
www.siteduzero.com
106/333
une valeur, le second paramtre est la valeur que l'on a tent d'assigner l'attribut. Cette mthode ne retourne rien. V ous pouvez simplement faire ce que bon vous semble. Exemple : Code : PHP <?php class MaClasse { private $unAttributPrive; public function __set($nom, $valeur) { echo 'Ah, on a tent d\'assigner l\'attribut <strong>', $nom, '</strong> la valeur <strong>', $valeur, '</strong> mais c\'est pas possible !<br />'; } } $obj = new MaClasse; $obj->attribut = 'Simple test'; $obj->unAttributPrive = 'Autre simple test'; ?>
la sortie s'affichera :
Rsultat affich par le script Tenez, petit exercice, stockez dans un tableau tous les attributs (avec leurs valeurs) que nous avons essay de modifier ou crer.
Solution : Code : PHP <?php class MaClasse { private $attributs = array(); private $unAttributPrive; public function __set($nom, $valeur) { $this->attributs[$nom] = $valeur; } public function afficherAttributs()
www.siteduzero.com
107/333
$obj = new MaClasse; $obj->attribut = 'Simple test'; $obj->unAttributPrive = 'Autre simple test'; $obj->afficherAttributs(); ?>
Pas compliqu faire, mais cela permet de pratiquer un peu. Parlons maintenant de __get. Cette mthode est appele lorsque l'on essaye d'accder un attribut qui n'existe pas ou auquel on n'a pas accs. Elle prend un paramtre : le nom de l'attribut auquel on a essay d'accder. Cette mthode peut retourner ce qu'elle veut (ce sera, en quelque sorte, la valeur de l'attribut inaccessible). Exemple : Code : PHP <?php class MaClasse { private $unAttributPrive; public function __get($nom) { return 'Impossible d\'accder l\'attribut <strong>' . $nom . '</strong>, dsol !<br />'; } } $obj = new MaClasse; echo $obj->attribut; echo $obj->unAttributPrive; ?>
Ce qui va afficher :
script Encore un exercice. Combinez l'exercice prcdent en vrifiant si l'attribut auquel on a tent d'accder est contenu dans le tableau de stockage
www.siteduzero.com
108/333
$obj = new MaClasse; $obj->attribut = 'Simple test'; $obj->unAttributPrive = 'Autre simple test'; echo $obj->attribut; echo $obj->autreAtribut; ?>
tant donn que tous vos attributs doivent tre privs, vous pouvez facilement les mettre en lecture seule grce __get. L'utilisateur aura accs aux attributs, mais ne pourra pas les modifier.
__isset et __unset
La premire mthode __isset est appele lorsque l'on appelle la fonction isset sur un attribut qui n'existe pas ou auquel on n'a pas accs. tant donn que la fonction initiale isset renvoie true ou false, la mthode magique __isset doit renvoyer un boolen. Cette mthode prend un paramtre : le nom de l'attribut que l'on a envoy la fonction isset. V ous pouvez par exemple utiliser la classe prcdente en implmentant la mthode __isset, ce qui peut nous donner : Code : PHP <?php class MaClasse { private $attributs = array(); private $unAttributPrive; public function __set($nom, $valeur) { $this->attributs[$nom] = $valeur; }
www.siteduzero.com
109/333
$obj = new MaClasse; $obj->attribut = 'Simple test'; $obj->unAttributPrive = 'Autre simple test'; if (isset($obj->attribut)) { echo 'L\'attribut <strong>attribut</strong> existe !<br />'; } else { echo 'L\'attribut <strong>attribut</strong> n\'existe pas !<br />'; } if (isset($obj->unAutreAttribut)) { echo 'L\'attribut <strong>unAutreAttribut</strong> existe !'; } else { echo 'L\'attribut <strong>unAutreAttribut</strong> n\'existe pas !'; } ?>
Ce qui affichera :
script Pour __unset, le principe est le mme. Cette mthode est appele lorsque l'on tente d'appeler la fonction unset sur un attribut inexistant ou auquel on n'a pas accs. On peut facilement implmenter __unset la classe prcdente de manire supprimer l'entre correspondante dans notre tableau $attributs. Cette mthode ne doit rien retourner. Code : PHP
www.siteduzero.com
110/333
$obj = new MaClasse; $obj->attribut = 'Simple test'; $obj->unAttributPrive = 'Autre simple test'; if (isset($obj->attribut)) { echo 'L\'attribut <strong>attribut</strong> existe !<br />'; } else { echo 'L\'attribut <strong>attribut</strong> n\'existe pas !<br />'; } unset($obj->attribut); if (isset($obj->attribut)) { echo 'L\'attribut <strong>attribut</strong> existe !<br />'; } else { echo 'L\'attribut <strong>attribut</strong> n\'existe pas !<br />'; } if (isset($obj->unAutreAttribut)) { echo 'L\'attribut <strong>unAutreAttribut</strong> existe !'; } else { echo 'L\'attribut <strong>unAutreAttribut</strong> n\'existe pas !'; } ?>
www.siteduzero.com
111/333
Ce qui donnera :
script
Bien. Laissons de ct les attributs pour le moment et parler cette fois-ci des mthodes que l'on appelle alors qu'on n'y a pas accs (soit elle n'existe pas, soit elle est prive). La mthode __call sera appele lorsque l'on essayera d'appeler une telle mthode. Elle prend deux arguments : le premier est le nom de la mthode que l'on a essay d'appeler et le second est la liste des arguments qui lui ont t passs (sous forme de tableau). Exemple : Code : PHP <?php class MaClasse { public function __call($nom, $arguments) { echo 'La mthode <strong>', $nom, '</strong> a t appele alors qu\'elle n\'existe pas ! Ses arguments taient les suivants : <strong>', implode($arguments, '</strong>, <strong>'), '</strong>'; } } $obj = new MaClasse; $obj->methode(123, 'test'); ?>
Rsultat :
www.siteduzero.com
112/333
script Et si on essaye d'appeler une mthode qui n'existe pas statiquement ? Et bien, erreur fatale ! Sauf si vous utilisez __callStatic. Cette mthode est appele lorsque vous appelez une mthode dans un contexte statique alors qu'elle n'existe pas. La mthode magique __callStatic doit obligatoirement tre static ! Code : PHP <?php class MaClasse { public function __call($nom, $arguments) { echo 'La mthode <strong>', $nom, '</strong> a t appele alors qu\'elle n\'existe pas ! Ses arguments taient les suivants : <strong>', implode ($arguments, '</strong>, <strong>'), '</strong><br />'; } public static function __callStatic($nom, $arguments) { echo 'La mthode <strong>', $nom, '</strong> a t appele dans un contexte statique alors qu\'elle n\'existe pas ! Ses arguments taient les suivants : <strong>', implode ($arguments, '</strong>, <strong>'), '</strong><br />'; } } $obj = new MaClasse; $obj->methode(123, 'test'); MaClasse::methodeStatique(456, 'autre test'); ?>
Rsultat :
www.siteduzero.com
113/333
script
Posons le problme
V ous avez un systme de sessions sur votre site avec une classe Connexion. Cette classe, comme son nom l'indique, aura pour rle d'tablir une connexion la BDD. V ous aimeriez bien stocker l'objet cr dans une variable $_SESSION mais vous ne savez pas comment faire. Ben si ! On fait $_SESSION['connexion'] = $objetConnexion et puis voil !
Oui, a fonctionne, mais savez-vous vraiment ce qui se passe quand vous effectuez une telle opration ? Ou plutt, ce qui se passe la fin du script ? En fait, la fin du script, le tableau de session est linaris automatiquement. Linariser signifie que l'on transforme une variable en chane de caractres selon un format bien prcis. Cette chane de caractres pourra, quand on le souhaitera, tre transforme dans l'autre sens (c'est--dire qu'on va restituer son tat d'origine). Pour bien comprendre ce principe, on va linariser nous-mmes notre objet. V oici ce que nous allons faire : Cration de l'objet ($objetConnexion = new Connexion;) ; transformation de l'objet en chane de caractres ($_SESSION['connexion'] = serialize($objetConnexion);) ; changement de page ; transformation de la chane de caractres en objet ($objetConnexion = unserialize($_SESSION['connexion']);).
Des explications s'imposent. Les nouveauts rencontres ici sont l'apparition de deux nouvelles fonctions : serialize et unserialize. La premire fonction, serialize, retourne l'objet pass en paramtre sous forme de chane de caractres. V ous vous demandez sans doutes comment on peut transformer un objet en chane de caractres : la rponse est toute simple. Quand on y rflchit, un objet c'est quoi ? C'est un ensemble d'attributs, tout simplement. Les mthodes ne sont pas stockes dans l'objet, c'est la classe qui s'en occupe. Notre chane de caractres contiendra donc juste quelque chose comme : Objet MaClasse contenant les attributs unAttribut qui vaut "Hello world !", autreAttribut qui vaut "Vive la linarisation", dernierAttribut qui vaut "Et un dernier pour la route !" . Ainsi, vous pourrez conserver votre objet dans une variable sous forme de chane de caractres. Si vous affichez cette chane par un echo par exemple, vous n'arriverez sans doute pas dchiffrer l'objet, c'est normal, ce n'est pas aussi simple que la chane que j'ai montre titre d'exemple . Cette fonction est automatiquement appele sur l'array $_SESSION la fin du script, notre objet est donc automatiquement linaris la fin du script. C'est uniquement dans un but didactique que nous linarisons manuellement. La seconde fonction, unserialize, retourne la chane de caractres passe en paramtre sous forme d'objet. En gros, cette fonction lit la chane de caractres, cre une instance de la classe correspondante et assigne chaque attribut la valeur qu'ils
www.siteduzero.com
114/333
avaient. Ainsi, vous pourrez utiliser l'objet retourn (appel de mthodes, attributs et diverses oprations) comme avant. Cette fonction est automatiquement appele ds le dbut du script pour restaurer le tableau de sessions prcdemment enregistr dans le fichier. Sachez toutefois que si vous avez linaris un objet manuellement, il ne sera jamais restaur automatiquement. Et quel est le rapport avec tes mthodes magiques ?
En fait, les fonctions cites ci-dessus (serialize et unserialize) ne se contentent pas de transformer le paramtre qu'on leur passe en autre chose : elles vrifient si, dans l'objet pass en paramtre (pour serialize), il y a une mthode __sleep, auquel cas elle est excute. Si c'est unserialize qui est appele, la fonction vrifie si l'objet obtenu comporte une mthode __wakeup, auquel cas elle est appele.
serialize et __sleep
La mthode magique __sleep est utilise pour nettoyer l'objet ou pour sauver des attributs. Si la mthode magique __sleep n'existe pas, tous les attributs seront sauvs. Cette mthode doit renvoyer un tableau avec les noms des attributs sauver. Par exemple, si vous voulez sauver $serveur et $login, la fonction devra retourner array('serveur', 'login');. V oici ce que pourrait donner notre classe Connexion : Code : PHP <?php class Connexion { protected $pdo, $serveur, $utilisateur, $motDePasse, $dataBase; public function __construct($serveur, $utilisateur, $motDePasse, $dataBase) { $this->serveur = $serveur; $this->utilisateur = $utilisateur; $this->motDePasse = $motDePasse; $this->dataBase = $dataBase; } $this->connexionBDD();
protected function connexionBDD() { $this->pdo = new PDO('mysql:host='.$this>serveur.';dbname='.$this->dataBase, $this->utilisateur, $this>motDePasse); } public function __sleep() { // Ici sont placer des instructions excuter juste avant la linarisation. // On retourne ensuite la liste des attributs qu'on veut sauver. return array('serveur', 'utilisateur', 'motDePasse', 'dataBase'); } } ?>
www.siteduzero.com
115/333
unserialize et __wakeup
Maintenant, nous allons simplement implmenter la fonction __wakeup. Qu'allons-nous mettre dedans ? Rien de compliqu Nous allons juste appeler la mthode connexionBDD qui se chargera de nous connecter notre base de donnes puisque les identifiants, serveur et nom de la base ont t sauvegards et ainsi restaurs l'appel de la fonction unserialize ! Code : PHP <?php class Connexion { protected $pdo, $serveur, $utilisateur, $motDePasse, $dataBase; public function __construct($serveur, $utilisateur, $motDePasse, $dataBase) { $this->serveur = $serveur; $this->utilisateur = $utilisateur; $this->motDePasse = $motDePasse; $this->dataBase = $dataBase; } $this->connexionBDD();
protected function connexionBDD() { $this->pdo = new PDO('mysql:host='.$this>serveur.';dbname='.$this->dataBase, $this->utilisateur, $this>motDePasse); } public function __sleep() { return array('serveur', 'utilisateur', 'motDePasse', 'dataBase'); } public function __wakeup() { $this->connexionBDD(); }
} ?>
Pratique, hein ? Maintenant que vous savez ce qui se passe quand vous enregistrez un objet dans une entre de session, je vous autorise ne plus appeler serialize et unserialize. Ainsi, ce code fonctionne parfaitement : Code : PHP <?php
www.siteduzero.com
116/333
else { echo '<pre>'; var_dump($_SESSION['connexion']); // On affiche les infos concernant notre objet. echo '</pre>'; } ?>
V ous voyez donc, en testant ce code, que notre objet a bel et bien t sauvegard comme il fallait, et que tous les attributs ont t sauvs. Bref, c'est magique. tant donn que notre objet est restaur automatiquement lors de l'appel de session_start(), la classe correspondante doit tre dclare avant, sinon l'objet dsrialis sera une instance de __PHP_Incomplete_Class_Name, classe qui ne contient aucune mthode (cela produira donc un objet inutile). Si vous avez un autoload qui chargera la classe automatiquement, il sera appel.
__toString
La mthode magique __toString est appele lorsque l'objet est amen tre converti en chane de caractres. Cette mthode doit retourner la chane de caractres souhaite. Exemple : Code : PHP <?php class MaClasse { protected $texte; public function __construct($texte) { $this->texte = $texte; } public function __toString() { return $this->texte; }
$obj = new MaClasse('Hello world !'); // Solution 1 : le cast $texte = (string) $obj; var_dump($texte); // Affiche : string(13) "Hello world !". // Solution 2 : directement dans un echo
www.siteduzero.com
117/333
__set_state
La mthode magique __set_state est appele lorsque vous appelez la fonction var_export en passant votre objet exporter en paramtre. Cette fonction var_export a pour rle d'exporter la variable passe en paramtre sous forme de code PHP (chane de caractres). Si vous ne spcifiez pas de mthode __set_state dans votre classe, une erreur fatale sera leve. Notre mthode __set_state prend un paramtre, la liste des attributs ainsi que leur valeur dans un tableau associatif (array('attribut' => 'valeur')). Notre mthode magique devra retourner l'objet exporter. Il faudra donc crer un nouvel objet et lui assigner les valeurs qu'on souhaite, puis le retourner. Ne jamais retourner $this, car cette variable n'existera pas dans cette mthode ! var_export reportera donc une valeur nulle.
Puisque la fonction var_export retourne du code PHP valide, on peut utiliser la fonction eval qui excute du code PHP sous forme de chane de caractres qu'on lui passe en paramtre. Par exemple, pour retourner un objet en sauvant ses attributs, on pourrait faire : Code : PHP <?php class Export { protected $chaine1, $chaine2; public function __construct($param1, $param2) { $this->chaine1 = $param1; $this->chaine2 = $param2; } public function __set_state($valeurs) // Liste des attributs de l'objet en paramtre. { $obj = new Export($valeurs['chaine1'], $valeurs['chaine2']); // On cre un objet avec les attributs de l'objet que l'on veut exporter. return $obj; // on retourne l'objet cr. } } $obj1 = new Export('Hello ', 'world !'); eval('$obj2 = ' . var_export ($obj1, true) . ';'); // On cre un autre objet, celui-ci ayant les mmes attributs que l'objet prcdent. echo '<pre>', print_r ($obj2, true), '</pre>'; ?>
www.siteduzero.com
118/333
script
__invoke
Disponible depuis PHP 5.3
Que diriez-vous de pouvoir utiliser l'objet comme fonction ? V ous ne voyez pas ce que je veux dire ? Je comprends. V oici un code qui illustrera bien le tout : Code : PHP <?php $obj = new MaClasse; $obj('Petit test'); // Utilisation de l'objet comme fonction. ?>
Essayez ce code et BAM ! Une erreur fatale (c'est bizarre ). Plus srieusement, pour rsoudre ce problme, nous allons devoir utiliser la mthode magique __invoke. Elle est appele ds qu'on essaye d'utiliser l'objet comme fonction (comme on vient de faire). Cette mthode comprend autant de paramtres que d'arguments passs la fonction. Exemple : Code : PHP <?php class MaClasse { public function __invoke($argument) { echo $argument; } } $obj = new MaClasse; $obj(5); // Affiche 5 . ?> Ce tutoriel portant sur les mthodes magiques s'arrte ici. Je parlerai de la mthode __clone lors du clonage d'objets en deuxime partie.
En rsum
www.siteduzero.com
119/333
Les mthodes magiques sont des mthodes qui sont appeles automatiquement lorsqu'un certain vnement est dclench. Toutes les mthodes magiques commencent par deux underscores, vitez donc d'appeler vos mthodes suivant ce mme modle. Les mthodes magiques dont vous vous servirez le plus souvent sont __construct, __set, __get et __call. Les autres sont plus gadget et vous les rencontrerez moins souvent.
www.siteduzero.com
120/333
Un objet, un identifiant
Je vais commencer cette partie en vous faisant une rvlation : quand vous instanciez une classe, la variable stockant l'objet ne stocke en fait pas l'objet lui-mme, mais un identifiant qui reprsente cet objet. C'est--dire qu'en faisant $objet = new Classe;, " $objet ne contient pas l'objet lui-mme, mais son identifiant unique. C'est un peu comme quand vous enregistrez des informations dans une BDD : la plupart du temps, vous avez un champ "id" unique qui reprsente l'entre. Quand vous faites une requte SQL, vous slectionnez l'lment en fonction de son id. Et bien l, c'est pareil : quand vous accdez un attribut ou une mthode de l'objet, PHP regarde l'identifiant contenu dans la variable, va chercher l'objet correspondant et effectue le traitement ncessaire. Il est trs important que vous compreniez cette ide, sinon vous allez tre compltement perdus pour la suite du chapitre. Nous avons donc vu que la variable $objet contenait l'identifiant de l'objet qu'elle a instanci. Vrifions cela : Code : PHP <?php class MaClasse { public $attribut1; public $attribut2; } $a = new MaClasse; $b = $a; // On assigne $b l'identifiant de $a, donc $a et $b reprsentent le mme objet. $a->attribut1 = 'Hello'; echo $b->attribut1; // Affiche Hello. $b->attribut2 = 'Salut'; echo $a->attribut2; // Affiche Salut. ?>
Je commente plus en dtail la ligne 10 pour ceux qui sont un peu perdus. Nous avons dit plus haut que $a ne contenait pas l'objet lui-mme mais son identifiant (un identifiant d'objet). $a contient donc l'identifiant reprsentant l'objet cr. Ensuite, on assigne $b la valeur de $a. Donc qu'est-ce que $b vaut maintenant ? Et bien la mme chose que $a, savoir l'identifiant qui reprsente l'objet ! $a et " $b font donc rfrence la mme instance. Schmatiquement, on peut reprsenter le code ci-dessus comme ceci :
www.siteduzero.com
121/333
d'objet Comme vous le voyez sur l'image, en ralit, il n'y a qu'un seul objet, qu'un seul identifiant, mais deux variables contenant exactement le mme identifiant d'objet. Tout ceci peut sembler abstrait, donc allez votre rythme pour bien comprendre. Maintenant que l'on sait que ces variables ne contiennent pas d'objet mais un identifiant d'objet, vous tes censs savoir que lorsqu'un objet est pass en paramtre une fonction ou renvoy par une autre, on ne passe pas une copie de l'objet mais une copie de son identifiant ! Ainsi, vous n'tes pas oblig de passer l'objet en rfrence, car vous passerez une rfrence de l'identifiant de l'objet. Inutile, donc. Cependant un problme se pose. Comment faire pour copier un objet ? Comment faire pour pouvoir copier tous ses attributs et valeurs dans un nouvel objet unique ? On a vu qu'on ne pouvait pas faire un simple $objet1 = $objet2 pour arriver cela. Comme vous vous en doutez peut-tre, c'est l qu'intervient le clonage d'objet. Pour cloner un objet, c'est assez simple. Il faut utiliser le mot-cl clone juste avant l'objet copier. Exemple : Code : PHP <?php $copie = clone $origine; // On copie le contenu de l'objet $origine dans l'objet $copie. ?>
C'est aussi simple que cela. Ainsi les deux objets contiennent des identifiants diffrents : par consquent, si on veut modifier l'un d'eux, on peut le faire sans qu'aucune proprit de l'autre ne soit modifie.
Si si, j'y viens. Lorsque vous clonez un objet, la mthode __clone de celui-ci sera appele (du moins, si vous l'avez dfinie). V ous ne pouvez pas appeler cette mthode directement. C'est la mthode __clone de l'objet cloner qui est appele, pas la mthode __clone du nouvel objet cr. V ous pouvez utiliser cette mthode pour modifier certains attributs pour l'ancien objet, ou alors incrmenter un compteur
www.siteduzero.com
122/333
$a = new MaClasse; $b = clone $a; echo 'Nombre d\'instances de MaClasse : ', MaClasse::getInstances(); ?>
Ce qui affichera :
script
www.siteduzero.com
123/333
Cette partie ne vous expliquera donc pas comment comparer des objets mais la dmarche que PHP excute pour les comparer et les effets que ces comparaisons peuvent produire. Reprenons le code ci-dessus. Pour que la condition renvoie true, il faut que $objet1 et $objet2 aient les mmes attributs et les mmes valeurs, mais galement que les deux objets soient des instances de la mme classe. C'est--dire que mme s'ils ont les mmes attributs et valeurs mais que l'un est une instance de la classe A et l'autre une instance de la classe B, la condition renverra false. Exemple : Code : PHP <?php class A { public $attribut1; public $attribut2; } class B { public $attribut1; public $attribut2; } $a = new A; $a->attribut1 = 'Hello'; $a->attribut2 = 'Salut'; $b = new B; $b->attribut1 = 'Hello'; $b->attribut2 = 'Salut'; $c = new A; $c->attribut1 = 'Hello'; $c->attribut2 = 'Salut'; if ($a == $b) { echo '$a == $b'; } else { echo '$a != $b'; } echo '<br />'; if ($a == $c) { echo '$a == $c'; } else { echo '$a != $c'; } ?>
www.siteduzero.com
124/333
script Comme on peut le voir, $a et $b ont beau avoir les mmes attributs et les mmes valeurs, ils ne sont pas identiques car ils ne sont pas des instances de la mme classe. Par contre, $a et $c sont bien identiques. Parlons maintenant de l'oprateur === qui permet de vrifier que deux objets sont strictement identiques. V ous n'avez jamais entendu parler de cet oprateur ? Allez lire ce tutoriel ! Cet oprateur vrifiera si les deux objets font rfrence vers la mme instance. Il vrifiera donc que les deux identifiants d'objets compars sont les mmes. Allez relire la premire partie de ce chapitre si vous tes un peu perdu. Faisons quelques tests pour tre sr que vous avez bien compris : Code : PHP <?php class A { public $attribut1; public $attribut2; } $a = new A; $a->attribut1 = 'Hello'; $a->attribut2 = 'Salut'; $b = new A; $b->attribut1 = 'Hello'; $b->attribut2 = 'Salut'; $c = $a; if ($a === $b) { echo '$a === $b'; } else { echo '$a !== $b'; } echo '<br />'; if ($a === $c) { echo '$a === $c'; } else { echo '$a !== $c'; } ?>
www.siteduzero.com
125/333
Et l'cran s'affichera :
script On voit donc que cette fois ci, la condition qui renvoyait true avec l'oprateur == renvoie maintenant false. $a et $c font rfrence la mme instance, la condition renvoie donc true.
V ous ne devez sans doute pas tre dpays, il n'y a presque rien de nouveau. Comme je vous l'ai dit, la boucle foreach parcourt les attributs visibles. Faisons quelques tests. Normalement, vous devez dj anticiper le bon rsultat (enfin, j'espre, mais si vous tes tomb ct de la plaque ce n'est pas un drame ! ). Code : PHP <?php class MaClasse { public $attribut1 = 'Premier attribut public'; public $attribut2 = 'Deuxime attribut public'; protected $attributProtege1 = 'Premier attribut protg'; protected $attributProtege2 = 'Deuxime attribut protg'; private $attributPrive1 = 'Premier attribut priv'; private $attributPrive2 = 'Deuxime attribut priv'; function listeAttributs() { foreach ($this as $attribut => $valeur)
www.siteduzero.com
126/333
class Enfant extends MaClasse { function listeAttributs() // Redclaration de la fonction pour que ce ne soit pas celle de la classe mre qui soit appele. { foreach ($this as $attribut => $valeur) { echo '<strong>', $attribut, '</strong> => ', $valeur, '<br />'; } } } $classe = new MaClasse; $enfant = new Enfant; echo '---- Liste les attributs depuis l\'intrieur de la classe principale ----<br />'; $classe->listeAttributs(); echo '<br />---- Liste les attributs depuis l\'intrieur de la classe enfant ----<br />'; $enfant->listeAttributs(); echo '<br />---- Liste les attributs depuis le script global ----<br />'; foreach ($classe as $attribut => $valeur) { echo '<strong>', $attribut, '</strong> => ', $valeur, '<br />'; } ?>
Ce qui affichera : ---- Liste les attributs depuis l'intrieur de la classe principale ---attribut1 => Premier attribut public attribut2 => Deuxime attribut public attributProtege1 => Premier attribut protg attributProtege2 => Deuxime attribut protg attributPrive1 => Premier attribut priv attributPrive2 => Deuxime attribut priv
---- Liste les attributs depuis l'intrieur de la classe enfant ---attribut1 => Premier attribut public attribut2 => Deuxime attribut public attributProtege1 => Premier attribut protg attributProtege2 => Deuxime attribut protg
---- Liste les attributs depuis le script global ---attribut1 => Premier attribut public attribut2 => Deuxime attribut public
www.siteduzero.com
127/333
J'ai volontairement termin ce chapitre par le parcours d'objets. Pourquoi ? Car dans le prochain chapitre nous verrons comment modifier le comportement de l'objet quand il est parcouru grce aux interfaces ! Celles-ci permettent de raliser beaucoup de choses pratiques, mais je ne vous en dis pas plus.
En rsum
Une variable ne contient jamais d'objet proprement parler, mais leurs identifiants. Pour dupliquer un objet, l'oprateur = n'a donc pas l'effet dsir : il faut cloner l'objet grce l'oprateur clone. Pour comparer deux objets, l'oprateur == vrifie que les deux objets sont issus de la mme classe et que les valeurs de chaque attribut sont identiques, tandis que l'oprateur === vrifie que les deux identifiants d'objet sont les mmes. Il est possible de parcourir un objet grce la structure foreach : ceci aura pour effet de lister tous les attributs auxquels la structure a accs (par exemple, si la structure est situe l'extrieur de la classe, seuls les attributs publics seront lists).
www.siteduzero.com
128/333
Les interfaces
Si, dans l'une de vos mthodes, on vous passe un objet quelconque, il vous est impossible de savoir si vous pouvez invoquer telle ou telle mthode sur ce dernier pour la simple et bonne raison que vous n'tes pas totalement sr que ces mthodes existent. En effet, si vous ne connaissez pas la classe dont l'objet est l'instance, vous ne pouvez pas vrifier l'existence de ces mthodes. En PHP, il existe un moyen d'imposer une structure nos classes, c'est--dire d'obliger certaines classes implmenter certaines mthodes. Pour y arriver, nous allons nous servir des interfaces . Une fois toute la thorie pose, nous allons nous servir d'interfaces pr-dfinies afin de jouer un petit peu avec nos objets.
1. Toutes les mthodes prsentes dans une interface doivent tre publiques. 2. Une interface ne peut pas lister de mthodes abstraites ou finales. 3. Une interface ne peut pas avoir le mme nom qu'une classe et vice-versa.
www.siteduzero.com
129/333
script Et oui, une erreur fatale est gnre car notre classe Personnage n'a pas implment la mthode prsente dans l'interface Movable. Pour que ce code ne gnre aucune erreur, il faut qu'il y ait au minimum ce code : Code : PHP <?php class Personnage implements Movable { public function move($dest) { } ?> }
Et l... l'erreur a disparu ! V ous pouvez trs bien, dans votre classe, dfinir une mthode comme tant abstraite ou finale.
Si vous hritez une classe et que vous implmentez une interface, alors vous devez d'abord spcifier la classe hriter avec le mot-cl extends puis les interfaces implmenter avec le mot-cl implements. Une interface vous oblige crire toutes ses mthodes, mais vous pouvez en rajouter autant que vous voulez.
V ous pouvez trs bien implmenter plus d'une interface par classe, condition que celles-ci n'aient aucune mthode portant le mme nom ! Exemple : Code : PHP <?php interface iA { public function test1(); } interface iB { public function test2(); } class A implements iA, iB {
www.siteduzero.com
130/333
www.siteduzero.com
131/333
Contrairement aux classes, les interfaces peuvent hriter de plusieurs interfaces la fois. Il vous suffit de sparer leur nom par une virgule. Exemple : Code : PHP <?php interface iA { public function test1(); } interface iB { public function test2(); } interface iC extends iA, iB { public function test3(); } ?>
Dans cet exemple, si on imagine une classe implmentant iC, celle-ci devra implmenter les trois mthodes test1, test2 et test3.
Interfaces prdfinies
Nous allons maintenant aborder les interfaces prdfinies. Grce certaines, nous allons pouvoir modifier le comportement de nos objets ou raliser plusieurs choses pratiques. Il y a beaucoup d'interfaces prdfinies, je ne vous les prsenterai pas toutes, seulement quatre d'entre elles. Dj, avec celles-ci, nous allons pouvoir raliser de belles choses, et puis vous tes libres de lire la documentation pour dcouvrir toutes les interfaces. Nous allons essayer ici de crer un tableau-objet .
L'interface Iterator
Commenons d'abord par l'interface Iterator. Si votre classe implmente cette interface, alors vous pourrez modifier le comportement de votre objet lorsqu'il est parcouru. Cette interface comporte 5 mthodes : current : renvoie l'lment courant ; key : retourne la cl de l'lment courant ; next : dplace le pointeur sur l'lment suivant ; rewind : remet le pointeur sur le premier lment ; valid : vrifie si la position courante est valide.
En crivant ces mthodes, on pourra renvoyer la valeur qu'on veut, et pas forcment la valeur de l'attribut actuellement lu. Imaginons qu'on ait un attribut qui soit un array. On pourrait trs bien crer un petit script qui, au lieu de parcourir l'objet,
www.siteduzero.com
132/333
Ce qui affichera :
www.siteduzero.com
133/333
L'interface SeekableIterator
Cette interface hrite de l'interface Iterator, on n'aura donc pas besoin d'implmenter les deux notre classe. SeekableIterator ajoute une mthode la liste des mthodes d'Iterator : la mthode seek. Cette mthode permet de placer le curseur interne une position prcise. Elle demande donc un argument : la position du curseur laquelle il faut le placer. Je vous dconseille de modifier directement l'attribut $position afin d'assigner directement la valeur de l'argument $position. En effet, qui vous dit que la valeur de l'argument est une position valide ? Je vous laisse rflchir quant l'implmentation de cette mthode. V oici la correction (j'ai repris la dernire classe) : Code : PHP <?php class MaClasse implements SeekableIterator { private $position = 0; private $tableau = array('Premier lment', 'Deuxime lment', 'Troisime lment', 'Quatrime lment', 'Cinquime lment'); /** * Retourne l'lment courant du tableau. */ public function current() { return $this->tableau[$this->position]; } /** * Retourne la cl actuelle (c'est la mme que la position dans notre cas). */ public function key() { return $this->position; } /** * Dplace le curseur vers l'lment suivant. */ public function next() { $this->position++; } /** * Remet la position du curseur 0.
www.siteduzero.com
134/333
/** * Dplace le curseur interne. */ public function seek($position) { $anciennePosition = $this->position; $this->position = $position; if (!$this->valid()) { trigger_error('La position spcifie n\'est pas valide', E_USER_WARNING); $this->position = $anciennePosition; } } /** * Permet de tester si la position actuelle est valide. */ public function valid() { return isset($this->tableau[$this->position]); } } $objet = new MaClasse; foreach ($objet as $key => $value) { echo $key, ' => ', $value, '<br />'; } $objet->seek(2); echo '<br />', $objet->current(); ?>
Ce qui affichera :
script
L'interface ArrayAccess
www.siteduzero.com
135/333
Nous allons enfin, grce cette interface, pouvoir placer des crochets la suite de notre objet avec la cl laquelle accder, comme sur un vrai tableau ! L'interface ArrayAccess liste quatre mthodes : offsetExists : mthode qui vrifiera l'existence de la cl entre crochets lorsque l'objet est pass la fonction isset ou empty (cette valeur entre crochet est pass la mthode en paramtre) ; offsetGet : mthode appele lorsqu'on fait un simple $obj['cl']. La valeur 'cl' est donc passe la mthode offsetGet ; offsetSet : mthode appele lorsqu'on assigne une valeur une entre. Cette mthode reoit donc deux arguments, la valeur de la cl et la valeur qu'on veut lui assigner. offsetUnset : mthode appele lorsqu'on appelle la fonction unset sur l'objet avec une valeur entre crochets. Cette mthode reoit un argument, la valeur qui est mise entre les crochets.
Maintenant, votre mission est d'implmenter cette interface et de grer l'attribut $tableau grce aux quatre mthodes. C'est parti ! Correction : Code : PHP <?php class MaClasse implements SeekableIterator, ArrayAccess { private $position = 0; private $tableau = array('Premier lment', 'Deuxime lment', 'Troisime lment', 'Quatrime lment', 'Cinquime lment'); /* MTHODES DE L'INTERFACE SeekableIterator */ /** * Retourne l'lment courant du tableau. */ public function current() { return $this->tableau[$this->position]; } /** * Retourne la cl actuelle (c'est la mme que la position dans notre cas). */ public function key() { return $this->position; } /** * Dplace le curseur vers l'lment suivant. */ public function next() { $this->position++; } /** * Remet la position du curseur 0. */ public function rewind() { $this->position = 0; } /**
www.siteduzero.com
136/333
www.siteduzero.com
137/333
Ce qui affiche :
Alors, on se rapproche vraiment du comportement d'un tableau, n'est-ce pas ? On peut faire tout ce qu'on veut, comme sur un tableau ! Enfin, il manque juste un petit quelque chose pour que ce soit absolument parfait...
L'interface Countable
Et voici la dernire interface que je vous prsenterai. Elle contient une mthode : la mthode count. Celle-ci doit obligatoirement renvoyer un entier qui sera la valeur renvoye par la fonction count appele sur notre objet. Cette mthode n'est pas bien complique implmenter, il suffit juste de retourner le nombre d'entres de notre tableau. Correction :
www.siteduzero.com
138/333
www.siteduzero.com
139/333
www.siteduzero.com
140/333
Ce qui affichera :
script
www.siteduzero.com
141/333
Pour vous faire pratiquer, tiens. Sachez que rcrire des classes ou fonctions natives de PHP est un excellent exercice (et c'est valable pour tous les langages de programmation). Je ne vais pas m'attarder sur cette classe, tant donn qu'elle s'utilise exactement comme la ntre. Elle possde les mmes mthodes, une diffrence prs : cette classe implmente un constructeur qui accepte un tableau en guise d'argument. Comme vous l'aurez devin, c'est ce tableau qui sera transform en objet. Ainsi, si vous faites un echo $monInstanceArrayIterator['cle'], alors l'cran s'affichera l'entre qui a pour cl cle du tableau pass en paramtre.
En rsum
Une interface reprsente un comportement. Les interfaces ne sont autre que des classes 100% abstraites. Une interface s'utilise dans une classe grce au mot-cl implements. Il est possibles d'hriter ses interfaces grce au mot-cl extends. Il existe tout un panel d'interfaces pr-dfinies vous permettant de raliser tout un tas de fonctionnalits intressantes, comme la cration d'objets-tableaux .
www.siteduzero.com
142/333
Les exceptions
Actuellement, vous connaissez les erreurs fatales, les alertes, les erreurs d'analyse ou encore les notices. Nous allons dcouvrir dans ce chapitre une faon diffrente de grer les erreurs. Nous allons, en quelque sorte, crer nos propres types d'erreurs . Les exceptions sont des erreurs assez diffrentes qui ne fonctionnent pas de la mme manire. Comme vous le verrez, cette nouvelle faon de grer ses erreurs est assez pratique. Par exemple, vous pouvez attraper l'erreur pour l'afficher comme vous voulez plutt que d'avoir un fameux et plutt laid Warning . Cela ne s'arrtera pas l. Puisque la gestion d'erreurs est assez importante sur un site, je ddie une partie de ce chapitre au moyen de grer ses erreurs facilement et proprement, que ce soit les erreurs que vous connaissez dj ou les exceptions.
echo additionner(12, 3), '<br />'; echo additionner('azerty', 54), '<br />'; echo additionner(4, 8); ?>
Et l, vous avez :
www.siteduzero.com
143/333
Rsultat affich
par le script Et voil votre premire exception qui apparat, d'une faon assez dsagrable, devant vos yeux bahis. Dcortiquons ce que PHP veut nous dire. Premirement, il gnre une erreur fatale. Et oui, une exception non attrape gnre automatiquement une erreur fatale. Nous verrons plus tard ce que signifie attraper . Deuximement, il nous dit Uncaught exception 'Exception' with message 'Les deux paramtres doivent tre des nombres' ce qui signifie Exception 'Exception' non attrape avec le message 'Les deux paramtres doivent tre des nombres' . Ce passage se passera de commentaire, la traduction parle d'elle-mme : on n'a pas attrap l'exception 'Exception' (= le nom de la classe instancie par l'objet qui a t lanc) avec tel message (ici, c'est le message spcifi dans le constructeur). Et pour finir, PHP nous dit o a t lance l'exception, depuis quelle fonction, quelle ligne, etc. Maintenant, puisque PHP n'a pas l'air content que l'on n'ait pas attrap cette exception, et bien c'est ce que nous allons faire. Ne lancez jamais d'exception dans un destructeur. Si vous faites une telle chose, vous aurez une erreur fatale : Exception thrown without a stack frame in Unknown on line 0. Cette erreur peut aussi tre lance dans un autre cas voqu plus tard.
www.siteduzero.com
144/333
catch (Exception $e) // On va attraper les exceptions "Exception" s'il y en a une qui est leve. { } ?>
Et l, miracle, vous n'avez plus que 15 qui s'affiche, et plus d'erreur ! Par contre, les deux autres rsultats ne sont pas affichs, et il serait intressant de savoir pourquoi. Nous allons afficher le message d'erreur. Pour ce faire, il faut appeler la mthode getMessage(). Si vous souhaitez rcuprer le code d'erreur, il faut appeler getCode(). Code : PHP <?php function additionner($a, $b) { if (!is_numeric($a) OR !is_numeric($b)) { throw new Exception('Les deux paramtres doivent tre des nombres'); } } return $a + $b;
try // Nous allons essayer d'effectuer les instructions situes dans ce bloc. { echo additionner(12, 3), '<br />'; echo additionner('azerty', 54), '<br />'; echo additionner(4, 8); } catch (Exception $e) // On va attraper les exceptions "Exception" s'il y en a une qui est leve { echo 'Une exception a t lance. Message d\'erreur : ', $e>getMessage(); } ?>
Ce qui affichera :
www.siteduzero.com
145/333
Comme vous pouvez le constater, la troisime instruction du bloc try n'a pas t excute. C'est normal puisque la deuxime instruction a interrompu la lecture du bloc. Si vous interceptez les exceptions comme nous l'avons fait, alors le script n'est pas interrompu. En voici la preuve : Code : PHP <?php function additionner($a, $b) { if (!is_numeric($a) OR !is_numeric($b)) { throw new Exception('Les deux paramtres doivent tre des nombres'); } } return $a + $b;
try // Nous allons essayer d'effectuer les instructions situes dans ce bloc. { echo additionner(12, 3), '<br />'; echo additionner('azerty', 54), '<br />'; echo additionner(4, 8); } catch (Exception $e) // Nous allons attraper les exceptions "Exception" s'il y en a une qui est leve. { echo 'Une exception a t lance. Message d\'erreur : ', $e>getMessage(); } echo 'Fin du script'; // Ce message s'affiche, a prouve bien que le script est excut jusqu'au bout. ?>
V ous vous demandez sans doute pourquoi on doit spcifier le nom de l'exception intercepter puisque c'est toujours une instance de la classe Exception. En fait, la classe Exception est la classe de base pour toute exception qui doit tre lance, ce qui signifie que l'on peut lancer n'importe quelle autre instance d'une classe, du moment qu'elle hrite de la classe Exception !
PHP nous offre la possibilit d'hriter la classe Exception afin de personnaliser nos exceptions. Par exemple, nous pouvons crer une classe MonException qui rcrira des mthodes de la classe Exception ou en crera de nouvelles qui lui seront propres.
www.siteduzero.com
146/333
Avant de foncer tte baisse dans l'criture de notre classe personnalise, encore faut-il savoir quelles mthodes et attributs seront disponibles. V oici la liste des attributs et mthodes de la classe Exception tire de la documentation : Code : PHP <?php class Exception { protected $message = 'exception inconnu'; // Message de l'exception. protected $code = 0; // Code de l'exception dfini par l'utilisateur. protected $file; // Nom du fichier source de l'exception. protected $line; // Ligne de la source de l'exception. final final final final final final function function function function function function getMessage(); // Message de l'exception. getCode(); // Code de l'exception. getFile(); // Nom du fichier source. getLine(); // Ligne du fichier source. getTrace(); // Un tableau de backtrace(). getTraceAsString(); // Chane formatte de trace.
} ?>
/* Remplacable */ function __construct ($message = NULL, $code = 0); function __toString(); // Chane formate pour l'affichage.
Ainsi, nous voyons que l'on a accs aux attributs protgs de la classe et qu'on peut rcrire les mthodes __construct et __toString. Toutes les autres mthodes sont finales, nous n'avons donc pas le droit de les rcrire. Nous allons donc crer notre classe MonException qui, par exemple, rcrira le constructeur en rendant obligatoire le premier argument ainsi que la mthode __toString pour n'afficher que le message d'erreur (c'est uniquement a qui nous intresse). Code : PHP <?php class MonException extends Exception { public function __construct($message, $code = 0) { parent::__construct($message, $code); } public function __toString() { return $this->message; }
} ?>
Maintenant, comme vous l'aurez peut-tre devin, nous n'allons pas lancer d'exception Exception mais une exception de type MonException. Dans notre script, nous allons dsormais attraper uniquement les exceptions MonException, ce qui claircira le code car c'est une manire de se dire que l'on ne travaille, dans le bloc try, qu'avec des instructions susceptibles de lancer des exceptions de type MonException. Exemple : Code : PHP
www.siteduzero.com
147/333
function additionner($a, $b) { if (!is_numeric($a) OR !is_numeric($b)) { throw new MonException('Les deux paramtres doivent tre des nombres'); // On lance une exception "MonException". } } return $a + $b;
try // Nous allons essayer d'effectuer les instructions situes dans ce bloc. { echo additionner(12, 3), '<br />'; echo additionner('azerty', 54), '<br />'; echo additionner(4, 8); } catch (MonException $e) // Nous allons attraper les exceptions "MonException" s'il y en a une qui est leve. { echo $e; // On affiche le message d'erreur grce la mthode __toString que l'on a crite. } echo '<br />Fin du script'; // Ce message s'affiche, a prouve bien que le script est excut jusqu'au bout. ?>
Ainsi, nous avons attrap uniquement les exceptions de type MonException. Essayez de lancer une exception Exception la place et vous verrez qu'elle ne sera pas attrape. Si vous dcidez d'attraper, dans le bloc catch, les exceptions Exception, alors toutes les exceptions seront attrapes car elles hritent toutes de cette classe. En fait, quand vous hritez une classe d'une autre et que vous dcidez d'attraper les exceptions de la classe parente, alors celles de la classe enfant le seront aussi.
www.siteduzero.com
148/333
function additionner($a, $b) { if (!is_numeric($a) OR !is_numeric($b)) { throw new MonException('Les deux paramtres doivent tre des nombres'); // On lance une exception "MonException". } if (func_num_args() > 2) { throw new Exception('Pas plus de deux arguments ne doivent tre passs la fonction'); // Cette fois-ci, on lance une exception "Exception". } } return $a + $b;
try // Nous allons essayer d'effectuer les instructions situes dans ce bloc. { echo additionner(12, 3), '<br />'; echo additionner(15, 54, 45), '<br />'; } catch (MonException $e) // Nous allons attraper les exceptions "MonException" s'il y en a une qui est leve. { echo '[MonException] : ', $e; // On affiche le message d'erreur grce la mthode __toString que l'on a crite. } catch (Exception $e) // Si l'exception n'est toujours pas attrape, alors nous allons essayer d'attraper l'exception "Exception". { echo '[Exception] : ', $e->getMessage(); // La mthode __toString() nous affiche trop d'informations, nous voulons juste le message d'erreur. } echo '<br />Fin du script'; // Ce message s'affiche, cela prouve bien que le script est excut jusqu'au bout. ?>
Cette fois-ci, aucune exception MonException n'est lance, mais une exception Exception l'a t. PHP va donc effectuer les oprations demandes dans le deuxime bloc catch.
www.siteduzero.com
149/333
Exceptions pr-dfinies
Il existe toute une quantit d'exceptions pr-dfinies. V ous pouvez obtenir cette liste sur la documentation. Au lieu de lancer tout le temps une exception en instanciant Exception, il est prfrable d'instancier la classe adapte la situation. Par exemple, reprenons le code propos en dbut de chapitre : Code : PHP <?php function additionner($a, $b) { if (!is_numeric($a) OR !is_numeric($b)) { // On lance une nouvelle exception grce throw et on instancie directement un objet de la classe Exception. throw new Exception('Les deux paramtres doivent tre des nombres'); } } return $a + $b;
echo additionner(12, 3), '<br />'; echo additionner('azerty', 54), '<br />'; echo additionner(4, 8);
La classe instancier ici est celle qui doit l'tre lorsqu'un paramtre est invalide. On regarde la documentation, et on tombe sur InvalidArgumentException. Le code donnerait donc : Code : PHP <?php function additionner($a, $b) { if (!is_numeric($a) OR !is_numeric($b)) { throw new InvalidArgumentException('Les deux paramtres doivent tre des nombres');
www.siteduzero.com
150/333
echo additionner(12, 3), '<br />'; echo additionner('azerty', 54), '<br />'; echo additionner(4, 8);
Cela permet de mieux se reprer dans le code et surtout de mieux cibler les erreurs grce aux multiples blocs catch.
Nous n'allons pas prter attention au dernier paramtre, juste aux quatre premiers. Nous allons crer notre propre classe MonException qui hrite non pas de Exception mais de ErrorException. Bien sr, comme je l'ai dj dit plus haut, toutes les exceptions hritent de la classe Exception : ErrorException n'chappe pas la rgle et hrite de celle-ci. La fonction set_error_handler demande deux paramtres. Le premier est la fonction appeler, et le deuxime, les erreurs intercepter. Par dfaut, ce paramtre intercepte toutes les erreurs, y compris les erreurs strictes. Le constructeur de la classe ErrorException demande cinq paramtres, tous facultatifs : Le message d'erreur. Le code de l'erreur. La svrit de l'erreur (erreur fatale, alerte, notice, etc.) reprsentes par des constantes pr-dfinies. Le fichier o l'erreur a t rencontre. La ligne laquelle l'erreur a t rencontre.
V oici quoi pourrait ressembler le code de base : Code : PHP <?php class MonException extends ErrorException { public function __toString() { switch ($this->severity) { case E_USER_ERROR : // Si l'utilisateur met une erreur fatale; $type = 'Erreur fatale'; break;
www.siteduzero.com
151/333
return '<strong>' . $type . '</strong> : [' . $this->code . '] ' . $this->message . '<br /><strong>' . $this->file . '</strong> la ligne <strong>' . $this->line . '</strong>'; } } function error2exception($code, $message, $fichier, $ligne) { // Le code fait office de svrit. // Reportez-vous aux constantes prdfinies pour en savoir plus. // http://fr2.php.net/manual/fr/errorfunc.constants.php throw new MonException($message, 0, $code, $fichier, $ligne); } set_error_handler('error2exception'); ?>
V ous voyez que dans la mthode __toString je mettais chaque fois E_X et E_USER_X. Les erreurs du type E_X sont gnres par PHP et les erreurs E_USER_X sont gnres par l'utilisateur grce trigger_error. Les erreurs E_ERROR (donc les erreurs fatales gnres par PHP) ne peuvent tre interceptes, c'est la raison pour laquelle je ne l'ai pas plac dans le switch. Ensuite, vous de faire des tests, vous verrez bien que a fonctionne merveille. Mais gardez bien a en tte : avec ce code, toutes les erreurs (mme les notices) qui ne sont pas dans un bloc try interrompront le script car elles mettront une exception ! On aurait trs bien pu utiliser la classe Exception mais ErrorException a t conu exactement pour ce genre de chose. Nous n'avons pas besoin de crer d'attribut stockant la svrit de l'erreur ou de rcrire le constructeur pour y stocker le nom du fichier et la ligne laquelle s'est produite l'erreur.
www.siteduzero.com
152/333
return '<strong>' . $type . '</strong> : [' . $this->code . '] ' . $this->message . '<br /><strong>' . $this->file . '</strong> la ligne <strong>' . $this->line . '</strong>'; } } function error2exception($code, $message, $fichier, $ligne) { // Le code fait office de svrit. // Reportez-vous aux constantes prdfinies pour en savoir plus. // http://fr2.php.net/manual/fr/errorfunc.constants.php throw new MonException($message, 0, $code, $fichier, $ligne); } function customException($e) { echo 'Ligne ', $e->getLine(), ' dans ', $e->getFile(), '<br /><strong>Exception lance</strong> : ', $e->getMessage(); } set_error_handler('error2exception'); set_exception_handler('customException'); ?>
Je dis bien que l'exception est intercepte et non attrape ! Cela signifie que l'on attrape l'exception, qu'on effectue des oprations puis qu'on la relche. Le script, une fois customException appel, est automatiquement interrompu.
Ne lancez jamais d'exception dans votre gestionnaire d'exception (ici customException). En effet, cela crerait une boucle infinie puisque votre gestionnaire lance lui-mme une exception. L'erreur lance est la mme que celle vue prcdemment : il s'agit de l'erreur fatale Exception thrown without a stack frame in Unknown on line 0 .
En rsum
Une exception est une erreur que l'on peut attraper grce aux mots-cl try et catch. Une exception est une erreur que l'on peut personnaliser, que ce soit au niveau de son affichage ou au niveau de ses renseignements (fichier concern par l'erreur, le numro de la ligne, etc.). Une exception se lance grce au mot-cl throw. Il est possible d'hriter des exceptions entre elles. Il existe un certain nombre d'exceptions dj disponibles dont il ne faut pas hsiter se servir pour respecter la logique du code.
www.siteduzero.com
153/333
Les traits
Depuis sa version 5.4, PHP intgre un moyen de rutiliser le code d'une mthode dans deux classes indpendantes. Cette fonctionnalit permet ainsi de repousser les limites de l'hritage simple (pour rappel, en PHP, une classe ne peut hriter que d'une et une seule classe mre). Nous allons donc nous pencher ici sur les traits afin de pallier le problme de duplication de mthode.
Posons le problme
Admettons que vous ayez deux classes, Writer et Mailer. La premire est charge d'crire du texte dans un fichier, tandis que la seconde envoie un texte par mail. Cependant, il est agrable de mettre en forme le texte. Pour cela, vous dcidez de formater le texte en HTML. Or, un problme se pose : vous allez devoir effectuer la mme opration (celle de formater en HTML) dans deux classes compltement diffrentes et indpendantes : Code : PHP <?php class Writer { public function write($text) { $text = '<p>Date : '.date('d/m/Y').'</p>'."\n". '<p>'.nl2br($text).'</p>'; file_put_contents('fichier.txt', $text); } }
Code : PHP <?php class Mailer { public function send($text) { $text = '<p>Date : '.date('d/m/Y').'</p>'."\n". '<p>'.nl2br($text).'</p>'; mail('login@fai.tld', 'Test avec les traits', $text); } }
Ici, le code est petit et la duplication n'est donc pas norme, mais elle est belle et bien prsente. Dans une application de plus grande envergure, ce code pourrait tre dupliqu pas mal de fois. Imaginez alors que vous dcidiez de formater autrement votre texte : catastrophe, il va falloir modifier chaque partie du code qui formatait du texte ! Penchons-nous donc vers les traits pour rsoudre ce problme.
www.siteduzero.com
154/333
Commentons ce code. Dans un premier temps, nous dfinissons un trait. Un trait, comme vous pouvez le constater, n'est autre qu'une mini-classe. Dedans, nous n'avons dclar qu'une seule mthode. Ensuite, nous dclarons deux classes, chacune utilisant le trait que nous avons cr. Comme vous pouvez le constater, l'utilisation d'un trait dans une classe se fait grce au mot-cl use. En utilisant ce mot-cl, toutes les mthodes du trait vont tre importes dans la classe. Comme en tmoigne le code de test en fin de fichier, les deux classes possdent bien une mthode hello() et celle-ci affiche bien Hello world ! .
Maintenant, nous allons modifier nos classes Writer et Mailer afin qu'elles utilisent ce trait pour formater le texte qu'elles exploiteront. Pour y arriver, je vous rappelle qu'il vous faut utiliser le mot-cl use pour importer toutes les mthodes du trait (ici, il n'y en a qu'une) dans la classe. V ous pourrez ainsi utiliser les mthodes comme si elles taient dclares dans la classe. V oici la correction : Code : PHP <?php class Writer {
www.siteduzero.com
155/333
Code : PHP <?php class Mailer { use HTMLFormater; public function send($text) { mail('login@fai.tld', 'Test avec les traits', $this>format($text)); } }
Libre vous de tester vos classes ! Par exemple, essayez d'excuter ce code : Code : PHP <?php $w = new Writer; $w->write('Hello world!'); $m = new Mailer; $m->send('Hello world!');
Nous venons ici de supprimer la duplication de code anciennement prsente. Cependant, les traits ne se rsument pas qu' a ! Regardons par exemple comment utiliser plusieurs traits dans une classe.
www.siteduzero.com
156/333
class Writer { use HTMLFormater, TextFormater; public function write($text) { file_put_contents('fichier.txt', $this->formatHTML($text)); }
Regardons de plus prs cette ligne n6. Pour commencer, notez qu'elle est dfinie dans une paire d'accolades suivant les noms des traits utiliser. l'intrieur de cette paire d'accolades se trouve la liste des mthodes prioritaires . Chaque dclaration de priorit se fait en se terminant par un point-virgule. Cette ligne signifie donc : La mthode format() du trait HTMLFormater crasera la mthode du mme nom du trait TextFormater (si elle y est dfinie).
www.siteduzero.com
157/333
class MaClasse { use MonTrait; public function sayHello() { echo 'Bonjour !'; }
www.siteduzero.com
158/333
www.siteduzero.com
159/333
trait B { use A; public function saySomethingElse() { echo 'Je suis le trait B !'; }
www.siteduzero.com
160/333
class MaClasse { use A { saySomething as sayWhoYouAre; } } $o = new MaClasse; $o->sayWhoYouAre(); // Affichera Je suis le trait A ! $o->saySomething(); // Affichera Je suis le trait A !
Code : PHP <?php trait A { public function saySomething() { echo 'Je suis le trait A !'; } } class MaClasse { use A { saySomething as protected sayWhoYouAre; } } $o = new MaClasse; $o->saySomething(); // Affichera Je suis le trait A ! . $o->sayWhoYouAre(); // Lvera une erreur fatale, car l'alias cr est une mthode protge.
www.siteduzero.com
161/333
Cependant, si la classe utilisant le trait dclarant une mthode abstraite est elle aussi abstraite, alors ce sera ses classes filles d'implmenter les mthodes abstraites du trait (elle peut le faire, mais elle n'est pas oblige). Exemple : Code : PHP <?php trait A { abstract public function saySomething(); } abstract class Mere { use A; } // Jusque-l, aucune erreur n'est leve. class Fille extends Mere { // Par contre, une erreur fatale est ici leve, car la mthode saySomething() n'a pas t implmente. }
En rsum
Les traits sont un moyen pour viter la duplication de mthodes. Un trait s'utilise grce au mot-cl use. Il est possible d'utiliser une infinit de traits dans une classe en rsolvant les conflits ventuels avec insteadof. Un trait peut lui-mme utiliser un autre trait. Il est possible de changer la visibilit d'une mthode ainsi que son nom grce au mot-cl as.
www.siteduzero.com
162/333
L'API de rflexivit
En tant que dveloppeur, vous savez que telle classe hrite de telle autre ou que tel attribut est protg par exemple. Cependant, votre script PHP, lui ne le sait pas : comment feriez-vous pour afficher l'cran par exemple que telle classe hrite de telle autre (dynamiquement bien entendu ) ? Cela est pour vous impossible. Je vais cependant vous dvoiler la solution : pour y parvenir, on se sert de l'API de rflexivit qui va justement nous permettre d'obtenir des informations sur nos classes, attributs et mthodes. Une fois que nos aurons vu tout cela, nous allons nous pencher sur un exemple d'utilisation. Pour cela, nous utiliserons une bibliothque qui se sert de l'API de rflexivit pour exploiter les annotations , terme sans doute inconnu en programmation pour la plupart d'entre vous.
La classe ReflectionClass possde beaucoup de mthodes et je ne pourrai, par consquent, toutes vous les prsenter.
Il est galement possible d'obtenir des informations sur une classe grce un objet. Nous allons pour cela instancier la classe ReflectionObject en fournissant l'instance en guise d'argument. Cette classe hrite de toutes les mthodes de ReflectionClass : elle ne rcrit que deux mthodes (dont le constructeur). La seconde mthode rcrite ne nous intresse pas. Cette classe n'implmente pas de nouvelles mthodes. Exemple d'utilisation trs simple : Code : PHP <?php $magicien = new Magicien(array('nom' => 'vyk12', 'type' => 'magicien')); $classeMagicien = new ReflectionObject($magicien); ?>
www.siteduzero.com
163/333
V ous pouvez aussi rcuprer cet attribut afin d'obtenir des informations le concernant comme nous venons de faire jusqu' maintenant avec notre classe. Nous verrons cela plus tard, une sous-partie entire sera ddie ce sujet.
Les mthodes
Si vous voulez savoir si la classe implmente telle mthode, alors il va falloir regarder du ct de ReflectionClass::hasMethod($methodName). Celle-ci retourne vrai si la mthode est implmente ou faux si elle ne l'est pas. Exemple : Code : PHP <?php if ($classeMagicien->hasMethod('lancerUnSort')) { echo 'La classe Magicien implmente une mthode lancerUnSort()'; } else { echo 'La classe Magicien n\'implmente pas de mthode lancerUnSort()'; } ?>
V ous pouvez, comme pour les attributs, rcuprer une mthode, et une sous-partie sera consacre la classe permettant d'obtenir des informations sur telle mthode.
Les constantes
Dans ce cas galement, il est possible de savoir si telle classe possde telle constante. Ceci grce la mthode ReflectionClass::hasConstant($constName). Exemple : Code : PHP <?php if ($classePersonnage->hasConstant('NOUVEAU')) { echo 'La classe Personnage possde une constante NOUVEAU'; } else { echo 'La classe Personnage ne possde pas de constante NOUVEAU'; } ?>
V ous pouvez aussi rcuprer la valeur de la constante grce ReflectionClass::getConstant($constName) : Code : PHP <?php
www.siteduzero.com
164/333
Nous pouvons galement retrouver la liste complte des constantes d'une classe sous forme de tableau grce ReflectionClass::getConstants() : Code : PHP <?php echo '<pre>', print_r($classePersonnage->getConstants(), true), '</pre>'; ?>
V oici une belle occasion de vous prsenter la mthode ReflectionClass::getName(). Cette mthode se contente de renvoyer le nom de la classe. Pour l'exemple avec le magicien, cela aurait t inutile puisque nous connaissions dj le nom de la classe, mais ici nous ne le connaissons pas (quand je dis que nous ne le connaissons pas, cela signifie qu'il n'est pas dclar explicitement dans les dernires lignes de code). Dans le domaine de l'hritage, nous pouvons galement citer ReflectionClass::isSubclassOf($className). Cette mthode nous renvoie vrai si la classe spcifie en paramtre est le parent de notre classe. Exemple : Code : PHP
www.siteduzero.com
165/333
Les deux prochaines mthodes que je vais vous prsenter ne sont pas en rapport direct avec l'hritage mais sont cependant utilises lorsque cette relation existe : il s'agit de savoir si la classe est abstraite ou finale. Nous avons pour cela les mthodes ReflectionClass::isAbstract() et ReflectionClass::isFinal(). Notre classe Personnage est abstraite, vrifions donc cela : Code : PHP <?php $classePersonnage = new ReflectionClass('Personnage'); // Est-elle abstraite ? if ($classePersonnage->isAbstract()) { echo 'La classe Personnage est abstraite'; } else { echo 'La classe Personnage n\'est pas abstraite'; } // Est-elle finale ? if ($classePersonnage->isFinal()) { echo 'La classe Personnage est finale'; } else { echo 'La classe Personnage n\'est pas finale'; } ?>
Dans le mme genre, ReflectionClass::isInstantiable() permet galement de savoir si notre classe est instanciable. Comme la classe Personnage est abstraite, elle ne peut pas l'tre. Vrifions cela : Code : PHP <?php if ($classePersonnage->isInstantiable()) { echo 'La classe Personnage est instanciable'; } else { echo 'La classe personnage n\'est pas instanciable'; } ?>
www.siteduzero.com
166/333
Les interfaces
V oyons maintenant les mthodes en rapport avec les interfaces. Comme je vous l'ai dj dit, une interface n'est autre qu'une classe entirement abstraite : nous pouvons donc instancier la classe ReflectionClass en spcifiant une interface en paramtre et vrifier si celle-ci est bien une interface grce la mthode ReflectionClass::isInterface(). Dans les exemples qui vont suivre, nous allons admettre que la classe Magicien implmente une interface iMagicien.
Code : PHP <?php $classeIMagicien = new ReflectionClass('iMagicien'); if ($classeIMagicien->isInterface()) { echo 'La classe iMagicien est une interface'; } else { echo 'La classe iMagicien n\'est pas une interface'; } ?>
V ous pouvez aussi savoir si telle classe implmente telle interface grce la mthode ReflectionClass::implementsInterface($interfaceName). Exemple : Code : PHP <?php if ($classeMagicien->implementsInterface('iMagicien')) { echo 'La classe Magicien implmente l\'interface iMagicien'; } else { echo 'La classe Magicien n\'implmente pas l\'interface iMagicien'; } ?>
Il est aussi possible de rcuprer toutes les interfaces implmentes, interfaces contenues dans un tableau. Pour cela, deux mthodes sont votre disposition : ReflectionClass::getInterfaces() et ReflectionClass::getInterfaceNames(). La premire renvoie autant d'instances de la classe ReflectionClass qu'il y a d'interfaces, chacune reprsentant une interface. La seconde mthode se contente uniquement de renvoyer un tableau contenant le nom de toutes les interfaces implmentes. Je pense qu'il est inutile de donner un exemple sur ce point-l.
Instanciation directe
L'appel du constructeur se fait en lui passant deux arguments. Le premier est le nom de la classe, et le second est le nom de l'attribut. Exemple : Code : PHP
www.siteduzero.com
167/333
Tout simplement.
Aprs avoir vu comment rcuprer un attribut, nous allons voir ce que l'on peut faire avec.
www.siteduzero.com
168/333
Il fonctionne pas ton code, j'ai une vieille erreur fatale qui me bloque tout...
En effet. Cette erreur fatale est leve car vous avez appel la mthode ReflectionProperty::getValue() sur un attribut non public. Il faut donc rendre l'attribut accessible grce ReflectionProperty::setAccessible($accessible), o $accessible vaut vrai ou faux selon si vous voulez rendre l'attribut accessible ou non. Code : PHP <?php $classeMagicien = new ReflectionClass('Magicien'); $magicien = new Magicien(array('nom' => 'vyk12', 'type' => 'magicien')); foreach ($classeMagicien->getProperties() as $attribut) { $attribut->setAccessible(true); echo $attribut->getName(), ' => ', $attribut->getValue($magicien); } ?>
Quand vous rendez un attribut accessible, vous pouvez modifier sa valeur grce ReflectionProperty::setValue($objet, $valeur), ce qui est contre le principe d'encapsulation. Pensez donc bien rendre l'attribut inaccessible aprs sa lecture en faisant $attribut>setAccessible(false).
Porte de l'attribut
Il est tout fait possible de savoir si un attribut est priv, protg ou public grce aux mthodes ReflectionProperty::isPrivate(), ReflectionProperty::isProtected() et ReflectionProperty::isPublic(). Code : PHP <?php $uneClasse = new ReflectionClass('MaClasse'); foreach ($uneClasse->getProperties() as $attribut) { echo $attribut->getName(), ' => attribut '; if ($attribut->isPublic()) { echo 'public'; } elseif ($attribut->isProtected()) { echo 'protg'; } else { echo 'priv'; }
} ?>
www.siteduzero.com
169/333
Il existe aussi une mthode permettant de savoir si l'attribut est statique ou non grce ReflectionProperty::isStatic(). Code : PHP <?php $uneClasse = new ReflectionClass('MaClasse'); foreach ($uneClasse->getProperties() as $attribut) { echo $attribut->getName(), ' => attribut '; if ($attribut->isPublic()) { echo 'public'; } elseif ($attribut->isProtected()) { echo 'protg'; } else { echo 'priv'; } if ($attribut->isStatic()) { echo ' (attribut statique)'; }
} ?>
Au lieu d'utiliser cette faon de faire, vous pouvez directement appeler ReflectionClass::getStaticPropertyValue($attr), o $attr est le nom de l'attribut. Dans le mme genre, on peut citer ReflectionClass::setStaticPropertyValue($attr, $value) o $value est la nouvelle valeur de l'attribut. Code : PHP <?php
www.siteduzero.com
170/333
V ous avez aussi la possibilit d'obtenir tous les attributs statiques grce ReflectionClass::getStaticProperties(). Le tableau retourn ne contient pas des instances de ReflectionProperty mais uniquement les valeurs de chaque attribut. Code : PHP <?php class A { public static $attr1 = 'Hello world !'; public static $attr2 = 'Bonjour le monde !'; } $classeA = new ReflectionClass('A'); foreach ($classeA->getStaticProperties() as $attr) { echo $attr; } // l'cran s'affichera Hello world ! Bonjour le monde ! ?>
www.siteduzero.com
171/333
Je suis sr que vous savez quelle mthode permet de savoir si elle est statique ou non. Code : PHP <?php $classeA = new ReflectionClass('A'); $methode = $classeA->getMethod('hello');
www.siteduzero.com
172/333
Abstraite ? Finale ?
Les mthodes permettant de savoir si une mthode est abstraite ou finale sont trs simples retenir : il s'agit de ReflectionMethod::isAbstract() et ReflectionMethod::isFinal(). Code : PHP <?php $classeA = new ReflectionClass('A'); $methode = $classeA->getMethod('hello'); echo 'La mthode ', $methode->getName(), ' est '; if ($methode->isAbstract()) { echo 'abstraite'; } elseif ($methode->isFinal()) { echo 'finale'; } else { echo ' normale '; } ?>
Constructeur ? Destructeur ?
Dans le mme genre, ReflectionMethod::isConstructor() et ReflectionMethod::isDestructor() permettent de savoir si la mthode est le constructeur ou le destructeur de la classe. Code : PHP <?php $classeA = new ReflectionClass('A'); $methode = $classeA->getMethod('hello'); if ($methode->isConstructor()) {
www.siteduzero.com
173/333
Pour que la premire condition renvoie vrai, il ne faut pas obligatoirement que la mthode soit nomme __construct. En effet, si la mthode a le mme nom que la classe, celle-ci est considre comme le constructeur de la classe car, sous PHP 4, c'tait de cette faon que l'on implmentait le constructeur : il n'y avait jamais de __construct. Pour que les scripts dvelopps sous PHP 4 soient aussi compatibles sous PHP 5, le constructeur peut galement tre implment de cette manire, mais il est clairement prfrable d'utiliser la mthode magique cre pour cet effet.
Une mthode semblable ReflectionMethod::invoke($object, $args) existe : il s'agit de ReflectionMethod::invokeArgs($object, $args). La diffrence entre ces deux mthodes est que la seconde demandera les arguments lists dans un tableau au lieu de les lister en paramtres. L'quivalent du code prcdent avec Reflection::invokeArgs() serait donc le suivant : Code : PHP <?php class A { public function hello($arg1, $arg2, $arg3 = 1, $arg4 = 'Hello world !') { var_dump($arg1, $arg2, $arg3, $arg4);
www.siteduzero.com
174/333
$a = new A; $hello = new ReflectionMethod('A', 'hello'); $hello->invokeArgs($a, array('test', 'autre test')); // Les deux arguments sont cette fois-ci contenus dans un tableau. // Le rsultat affich est exactement le mme. ?>
Si vous n'avez pas accs la mthode cause de sa porte restreinte, vous pouvez la rendre accessible comme on l'a fait avec les attributs, grce la mthode ReflectionMethod::setAccessible($bool). Si $bool vaut true, alors la mthode sera accessible, sinon elle ne le sera pas. Je me passe d'exemple, je suis sr que vous trouverez tous seuls.
Les annotations s'insrent peu prs de la mme faon, mais la syntaxe est un peu diffrente. En effet, la syntaxe doit tre prcise pour qu'elle puisse tre parse par la bibliothque que nous allons utiliser pour rcuprer les donnes souhaites.
Prsentation d'addendum
Cette section aura pour but de prsenter les annotations par le biais de la bibliothque addendum qui parsera les codes pour en extraire les informations. Pour cela, commencez par tlcharger addendum, et dcompressez l'archive dans le dossier contenant votre projet. Commenons par crer une classe sur laquelle nous allons travailler tout au long de cette partie, comme Personnage ( tout hasard). Avec addendum, toutes les annotations sont des classes hritant d'une classe de base : Annotation. Si nous voulons ajouter une annotation, Table par exemple, notre classe pour spcifier quelle table un objet Personnage correspond, alors il faudra au pralable crer une classe Table. Pour travailler simplement, crez sur votre ordinateur un dossier annotations contenant un fichier index.php, un fichier Personnage.class.php qui contiendra notre classe, un fichier MyAnnotations.php qui contiendra nos annotations, et enfin le dossier addendum.
toute annotation correspond une valeur, valeur spcifier lors de la dclaration de l'annotation :
www.siteduzero.com
175/333
Nous venons donc de crer une annotation basique, mais concrtement, nous n'avons pas fait grand-chose. Nous allons maintenant voir comment rcuprer cette annotation, et plus prcisment la valeur qui lui est assigne, grce addendum. quoi servent-elles ces annotations ?
Les annotations sont surtout utilises par les frameworks, comme PHPUnit (framework de tests unitaires) ou Zend Framework par exemple, ou bien les ORM tel que Doctrine, qui apportent ici des informations pour le mapping des classes. V ous n'aurez donc peut-tre pas utiliser les annotations dans vos scripts, mais il est important d'en avoir entendu parler si vous dcidez d'utiliser des frameworks ou bibliothques les utilisant.
Maintenant que c'est fait, nous allons pouvoir rcuprer l'annotation grce la mthode getAnnotation. De manire gnrale, cette mthode retourne une instance de Annotation. Dans notre cas, puisque nous voulons l'annotation Table, ce sera une instance de Table qui sera retourne. La valeur de l'annotation est contenue dans l'attribut value, attribut public disponible dans toutes les classes filles de Annotation : Code : PHP <?php // On commence par inclure les fichiers ncessaires. require 'addendum/annotations.php'; require 'MyAnnotations.php'; require 'Personnage.class.php'; $reflectedClass = new ReflectionAnnotatedClass('Personnage'); echo 'La valeur de l\'annotation <strong>Table</strong> est <strong>', $reflectedClass->getAnnotation('Table')->value, '</strong>';
Il est aussi possible, pour une annotation, d'avoir un tableau comme valeur. Pour raliser ceci, il faut mettre la valeur de l'annotation entre accolades et sparer les valeurs du tableau par des virgules :
www.siteduzero.com
176/333
Si vous rcuprez l'annotation, vous obtiendrez un tableau classique : Code : PHP <?php print_r($reflectedClass->getAnnotation('Type')->value); // Affiche le dtail du tableau.
V ous pouvez aussi spcifier des cls pour les valeurs comme ceci : Code : PHP <?php /** * @Type({meilleur = 'magicien', 'moins bon' = 'brute', neutre = 'guerrier'}) */ class Personnage { }
Notez la mise entre quotes de moins bon : elles sont utiles ici car un espace est prsent. Cependant, comme vous le voyez avec meilleur et neutre, elles ne sont pas obligatoires.
Enfin, pour finir avec les tableaux, je prcise que vous pouvez en emboter tant que vous voulez. Pour placer un tableau dans un autre, il suffit d'ouvrir une nouvelle paire d'accolades : Code : PHP <?php /** * @UneAnnotation({uneCle = 1337, {uneCle2 = true, uneCle3 = 'une valeur'}}) */
www.siteduzero.com
177/333
Il est important ici que les attributs soient publics pour que le code extrieur la classe puisse modifier leur valeur.
Maintenant, tout se joue lors de la cration de l'annotation. Pour assigner les valeurs souhaites aux attributs, il suffit d'crire ces valeurs prcdes du nom de l'attribut. Exemple : Code : PHP <?php /** * @ClassInfos(author = "vyk12", version = "1.0") */ class Personnage { }
Pour accder aux valeurs des attributs, il faut rcuprer l'annotation, comme nous l'avons fait prcdemment, et rcuprer l'attribut. Code : PHP <?php
www.siteduzero.com
178/333
Le fait que les attributs soient publics peut poser quelques problmes. En effet, de la sorte, nous ne pouvons pas tre srs que les valeurs assignes soient correctes. Heureusement, la bibliothque nous permet de pallier ce problme en rcrivant la mthode checkConstraints() (dclare dans sa classe mre Annotation) dans notre classe reprsentant l'annotation, appele chaque assignation de valeur, dans l'ordre dans lequel sont assignes les valeurs. V ous pouvez ainsi vrifier l'intgrit des donnes, et lancer une erreur si il y a un problme. Cette mthode prend un argument : la cible d'o provient l'annotation. Dans notre cas, l'annotation vient de notre classe Personnage, donc le paramtre sera une instance de ReflectionAnnotatedClass reprsentant Personnage. V ous verrez ensuite que cela peut tre une mthode ou un attribut. Code : PHP <?php class ClassInfos extends Annotation { public $author; public $version; public function checkConstraints($target) { if (!is_string($this->author)) { throw new Exception('L\'auteur doit tre une chane de caractres'); } if (!is_numeric($this->version)) { throw new Exception('Le numro de version doit tre un nombre valide'); } } }
www.siteduzero.com
179/333
Pour rcuprer une de ces annotations, il faut d'abord rcuprer l'attribut ou la mthode. Nous allons pour cela se tourner vers ReflectionAnnotatedProperty et ReflectionAnnotatedMethod. Le constructeur de ces classes attend en premier paramtre le nom de la classe contenant l'lment et, en second, le nom de l'attribut ou de la mthode. Exemple : Code : PHP <?php $reflectedAttr = new ReflectionAnnotatedProperty('Personnage', 'force_perso'); $reflectedMethod = new ReflectionAnnotatedMethod('Personnage', 'deplacer'); echo 'Infos concernant l\'attribut :'; var_dump($reflectedAttr->getAnnotation('AttrInfos')); echo 'Infos concernant les paramtres de la mthode :'; var_dump($reflectedMethod->getAllAnnotations('ParamInfo')); echo 'Infos concernant la mthode :'; var_dump($reflectedMethod->getAnnotation('MethodInfos'));
Notez ici l'utilisation de ReflectionAnnotatedMethod::getAllAnnotations(). Cette mthode permet de rcuprer toutes les annotations d'une entit correspondant au nom donn en argument. Si aucun nom n'est donn, alors toutes les annotations de l'entit seront retournes.
prsent, essayez d'utiliser l'annotation @ClassInfos sur un attribut ou une mthode et vous verrez qu'une erreur sera leve.
www.siteduzero.com
180/333
Cette annotation peut aussi prendre pour valeur property, method ou nesty. Ce dernier type est un peu particulier et cette partie commenant dj devenir un peu imposante, j'ai dcid de ne pas en parler. Si cela vous intresse, je ne peux que vous conseiller d'aller faire un tour sur la documentation d'addendum. Je vous ai aussi volontairement cach une classe : la classe ReflectionParameter qui vous permet d'obtenir des informations sur les paramtres de vos mthodes. Je vous laisse vous documenter ce sujet, son utilisation est trs simple.
En rsum
Il est possible d'obtenir des informations sur ses classes, attributs et mthodes, respectivement grce ReflectionClass, ReflectionProperty et ReflectionMethod. Utiliser des annotations sur ses classes permet, grce une bibliothque telle qu'addendum, de rcuprer dynamiquement leurs contenus. L'utilisation d'annotations dans un but de configuration dynamique est utilise par certains frameworks ou ORM tel que Doctrine par exemple, ce qui permet d'conomiser un fichier de configuration en plaant la description des tables et des colonnes directement dans des annotations.
www.siteduzero.com
181/333
UML, kzako ?
L'UML est un langage de modlisation objet. Il permet donc de modliser vos objets et ainsi reprsenter votre application sous forme de diagramme. Avant d'aller plus loin, attardons nous un peu sur la signification d'UML : Unified Modeling Language , langage de modlisation unifi . UML n'est pas un langage proprement parler, plutt une sorte de mthodologie. Mais qu'est-ce que c'est concrtement ? quoi a pourra bien me servir ?
Grce UML, vous pourrez modliser toute votre application. Quand je dis toute, j'entends par l la plupart de votre application car PHP n'est pas un langage orient objet : le modle objet lui a t implment au cours des versions (ds la version 4). Grce ces diagrammes, vous pourrez donc reprsenter votre application : son fonctionnement, sa mise en route, les actions susceptibles d'tre effectues par l'application, etc. Ces diagrammes ont t conus pour que quelqu'un n'ayant aucune connaissance en informatique puisse comprendre le fonctionnement de votre application. Certes, certains diagrammes sont rservs aux dveloppeurs car assez difficiles expliquer si on ne sait pas programmer : ce sont ces diagrammes que nous allons tudier. D'accord, je peux modliser mon application mais en quoi cela va-t-il m'aider ?
Si vous avez un gros projet (et l je ne parle pas forcment de PHP mais de tout langage implmentant la POO), il peut tre utile de le modliser afin d'y voir plus clair. Si vous vous focalisez sur la question Par o commencer ? au dbut du projet, c'est qu'il vous faut un regard plus objectif sur le projet. Les diagrammes vous apporteront ce regard diffrent sur votre application. L'UML peut aussi tre utile quand on commence programmer OO mais qu'on ne sait pas trop comment s'y prendre. Par exemple, vous ne savez pas trop encore comment programmer orient objet de faon concrte (vous avez vu comment crer un mini-jeu, c'est cool, mais un livre d'or ou un systme de news, vous savez ?). Sachez donc que l'UML va vous tre d'une grande aide au dbut. a vous aidera mieux penser objet car les diagrammes reprsentent vos classes, vous vous rendrez ainsi mieux compte de ce qu'il est intelligent de faire ou pas. Cependant, l'UML n'est pas un remde miracle et vous ne saurez toujours pas comment vous y prendre pour raliser votre toute premire application, mais une fois que je vous aurai montr et que vous aurez acquis un minimum de pratique, l'UML pourra vous aider. Enfin, l'UML a aussi un rle de documentation. En effet, quand vous reprsenterez votre projet sous forme de diagramme, quiconque sachant le dchiffrer pourra (du moins, si vous l'avez bien construit) comprendre le droulement de votre application et ventuellement reprendre votre projet (c'est toujours mieux que la phpdoc que nous utilisions jusqu' prsent pour commenter nos classes (revenez au dernier TP si vous avez un trou de mmoire)). Bref, que ce soient pour les gros projets personnels ou professionnels, l'UML vous suivra partout. Cependant, tout le monde ne trouve pas l'UML trs utile et certains prfrent modliser le projet dans leur tte . V ous verrez avec le temps si vous avez rellement besoin de l'UML ou si vous pouvez vous en passer, mais pour l'instant, je vous conseille de modliser (enfin, ds le prochain chapitre). Il existe plusieurs types de diagrammes. Nous, nous allons tudier les diagrammes de classe. Ce sont des diagrammes modlisant vos classes et montrant les diffrentes interactions entre elles. Un exemple ? Regardez plutt la figure suivante.
www.siteduzero.com
182/333
Diagramme UML modlisant notre dernier TP V ous aurez sans doutes reconnu notre dernier TP reprsent sur un diagramme. Ce diagramme a l'avantage d'tre trs simple tudier. Cependant, il y a des cas complexes et des conventions connatre car, par exemple, des mthodes abstraites n'ont pas le mme style d'criture qu'une mthode finale. Nous allons tudier les bases, petit petit, puis, la fin de ce chapitre, vous serez capable d'analyser compltement un diagramme de classe.
Nous avons donc ici une simple classe. Commenons par analyser celle-ci. En haut, en gras et gros, nous avons le nom de la classe (ici, News). Ensuite, spar du nom de la classe, vient un attribut de cette classe : il s'agit de id prcd d'un #, nous verrons ce que a signifie juste aprs. Enfin, spare de la liste d'attributs, vient la liste des mthodes de la classe. Toutes sont prcdes d'un +, qui a, comme le #, une signification. Nous allons commencer par analyser la signification du # et des +. Je ne vous fais pas attendre : ces signes symbolisent la porte de l'attribut ou de la mthode. V oici la liste des trois symboles : Le signe + : l'lment suivi de ce signe est public. Le signe # : l'lment suivi de ce signe est protg.
www.siteduzero.com
183/333
Maintenant que vous savez quoi correspondent ces signes, regardez droite de l'attribut : suivi de deux points, on peut lire int. Cela veut dire que cet attribut est de type int, tout simplement. int est le diminutif de integer qui veut dire entier : notre attribut est donc un nombre entier. droite des mthodes, nous pouvons apercevoir la mme chose. Ceci indique le type de la valeur de retour de celle-ci. Si elle ne renvoie rien, alors on dit qu'elle est vide (= void). Si elle peut renvoyer plusieurs types de rsultats diffrents, alors on dit qu'elle est mixte (= mixed). Par exemple, une mthode __get peut renvoyer une chane de caractres ou un entier (regardez la classe Personnage sur le premier diagramme). Encore une dernire chose expliquer sur ce diagramme : ce qu'il y a entre les parenthses suivant le nom des mthodes. Comme vous vous en doutez, elles contiennent tous les attributs ainsi que leur type (entier, tableau, chane de caractres, etc.). Si un paramtre peut tre de plusieurs types, alors, comme pour les valeurs de retour des mthodes, on dit qu'il est mixte. Si un attribut, une mthode ou un paramtre est une instance ou en renvoie une, il ne faut pas dire que son type est object. Son type est le nom de la classe, savoir Personnage, Brute, Magicien, Guerrier, etc.
Ensuite, il y a des conventions concernant le style d'criture des attributs, des constantes et des mthodes. Sans style d'criture particulier, la mthode est normale , c'est--dire ni abstraite, ni finale (comme ici). Si la mthode est en italique, cela signifie qu'elle est abstraite. Pour montrer qu'une mthode est finale, on le spcifie en strotype (on place le mot leaf entre chevrons ct de la mthode). Si l'attribut ou la mthode est soulign, cela signifie que l'lment est statique. Une constante est reprsente comme tant un attribut public, statique, de type const et est crite en majuscules. Exemple rcapitulant tout a (voir la figure suivante).
Tous ces codes (textes en gras, souligns ou en italiques) sont une norme qu'il faut respecter. Tout le monde sait qu'une mthode en italique signifie qu'elle est abstraite par exemple : ne faites donc pas comme bon vous semble !
Exercices
Maintenant que vous savez tout cela, je vais vous donner quelques attributs et mthodes et vous allez essayer de deviner quels sont ses particularits (porte, statique ou non, abstraite, finale, ou ni l'un ni l'autre, les arguments et leur type...). Exercice 1 : -maMethode (param1:int) : void Correction : nous avons ici une mthode maMethode qui est abstraite (car en italique) et statique (car souligne). Elle ne renvoie rien et accepte un argument : $param1, qui est un entier. Sans oublier sa visibilite, symbolise par le signe -, qui est prive. Exercice 2 : #maMethode (param1:mixed) : array Correction : nous avons ici une mthode maMethode ni abstraite, ni finale. Elle renvoie un tableau et accepte un argument : $param1, qui peut tre de plusieurs types. Sans oublier sa visibilite, symbolise par le signe #, qui est protge. Exercice 3 : +<<leaf>> maMethode() : array
www.siteduzero.com
184/333
Les diffrents codes (italique, soulignements, etc.) rentreront dans votre tte au fil du temps, je ne vous impose pas de tous les apprendre sur-le-champ. Rfrez-vous autant que ncessaire cette partie en cas de petits trous de mmoire. Maintenant que vous savez analyser un objet, il serait bien de savoir analyser les interactions entre ceux-ci, non ?
L'hritage
Parmi les interactions, on peut citer l'hritage. Comme montr dans le premier diagramme que vous avez vu, l'hritage est symbolis par une simple flche, comme indiqu la figure suivante.
Exemple de modlisation
d'une classe fille et d'une classe mre Ce diagramme quivaut au code suivant : Code : PHP <?php class Mere { protected $attribut1; protected $attribut2; public function methode() { } }
class Fille extends Mere { protected $attribut3; public function __set($nom, $valeur) { } ?> }
Les interfaces
V ous connaissez galement les interactions avec les interfaces. En effet, comme je l'ai dj dit, une interface n'est rien d'autre qu'une classe entirement abstraite, elle est donc considre comme tel. Si une classe doit implmenter une interface, alors on utilisera la flche en pointills, comme la figure suivante.
www.siteduzero.com
185/333
une interface Traduit en PHP, a donne : Code : PHP <?php interface iMaClasse { public function methode1(); public function methode2(); } class MaClasse implements iMaClasse { protected $attribut; public function methode() { } // Ne pas oublier d'implmenter les mthodes de l'interface ! public function methode1() { } public function methode2() { } ?> }
L'association
Nous allons voir encore trois interactions qui se ressemblent. La premire est l'association. On dit que deux classes sont associes lorsqu'une instance des deux classes est amene interagir avec l'autre instance. L'association entre deux classes est modlise comme la figure suivante.
Exemple de modlisation d'une association L'association est ici caractrise par le fait qu'une mthode de la classe NewsManager entre en relation avec une instance de la classe News. Attends deux secondes... Je vois des choses crites sur la ligne ainsi qu'aux extrmits, qu'est-ce que c'est ?
Le mot crit au centre, au-dessus de la ligne est la dfinition de la relation. Il est suivi d'un petit symbole indiquant le sens de
www.siteduzero.com
186/333
Ensuite, vous voyez le chiffre 1 crit gauche et une astrisque droite. Ce sont les cardinalits . Ces cardinalits prsentent le nombre d'instances qui participent l'interaction. Nous voyons donc qu'il y a 1 manager pour une infinit de news. On peut dsormais lire facilement 1 NewsManager gre une infinit de News . Les cardinalits peuvent tre crites sous diffrentes formes : x (nombre entier) : tout simplement la valeur exacte de x . x..y : de x y (exemple : 1..5 ). * : une infinit. x..* : x ou plus (exemple : 5..* ).
L'agrgation
La deuxime flche que je vais vous prsenter est l'agrgation. Il s'agit d'une forme d'association un peu particulire : on parlera d'agrgation entre deux classes lorsque l'une d'entre elles contiendra au moins une instance de l'autre classe. Une agrgation est caractrise de la sorte (voir figure suivante).
Exemple de modlisation d'une agrgation V ous pouvez remarquer qu'il n'y a pas de cardinalit du ct du losange. En effet, le ct ayant le losange signifie qu'il y a obligatoirement une et une seule instance de la classe par relation (ici la classe est NewsCollection).
La composition
La dernire interaction que je vais vous prsenter est la composition. La composition est une agrgation particulire. Imaginons que nous avons une classe A qui contient une ou plusieurs instance(s) de B. On parlera de composition si, lorsque l'instance de A sera supprime, toutes les instances de B contenues dans l'instance de A sont elles aussi supprimes (ce qui n'tait pas le cas avec l'agrgation). Une composition est reprsente de la sorte (voir la figure suivante).
Exemple de modlisation
d'une composition
Notez la prsence de la mthode __destruct() qui sera charge de dtruire les instances de la classe News. Cependant, celle-ci n'est pas obligatoire : vous pouvez trs bien, dans l'une de vos mthodes, placer un $this->liste[] = new News;, et l'instance cre puis stocke dans l'attribut $liste sera donc automatiquement dtruit. Ce chapitre ne se veut pas complet pour la simple et bonne raison qu'il serait beaucoup trop long de faire le tour de l'UML. En effet, un cours complet sur l'UML s'talerait sur beaucoup de chapitres, et ce n'est clairement pas le but du tutoriel. Si ce sujet vous intresse, je peux vous renvoyer sur le site uml.free.fr.
En rsum
L'UML est un moyen parmi d'autres de modliser son application afin de mieux s'y retrouver. La modlisation d'une classe et des interactions se ralise en respectant certaines conventions. Il y a association lorsqu'une classe A se sert d'une classe B. Une agrgation est une association particulire : il y a agrgation entre A et B si l'objet A possde une ou plusieurs instances de B. Une composition est une agrgation particulire : il y a composition entre A et B si toutes les instances de B contenues dans A sont supprimes lorsque A est supprime.
www.siteduzero.com
187/333
www.siteduzero.com
188/333
Installation
Des installateurs sont disponibles sur le site dia-installer.de. Le lien de tlchargement pour Windows est sur la page d'accueil. Deux petits liens situs en-dessous de ce lien de tlchargement mnent aux pages proposant les liens pour Linux et Mac OS X.
Lancer Dia
Histoire que nous soyons tous au point, je vais vous demander de lancer votre logiciel afin que nous soyons bien srs d'avoir tous le mme. Si l'interface est diffrente, veillez bien avoir tlcharg la version 0.97 du logiciel (actuellement la dernire). Si une version plus rcente est sortie, vous pouvez me contacter.
www.siteduzero.com
189/333
Sous Windows
Sous Windows, vous pouvez crer un raccourci. Pour cela, allez dans le dossier d'installation de Dia puis dans le dossier bin. Faites un clic droit sur le fichier diaw.exe et cliquez sur Copier. Allez dans le rpertoire o vous voulez crer le raccourci, faites un clic droit dans ce rpertoire puis choisissez l'option Coller le raccourci . Faites un clic droit sur le fichier cr, puis cliquez sur Proprits . Dans le champ texte Cible, rajoutez la fin (en dehors des guillemets) --integrated. Ainsi, quand vous lancerez Dia depuis ce raccourci, les deux fentres seront fusionnes.
www.siteduzero.com
190/333
Par dfaut, le raccourci prsent dans le menu dmarrer lance Dia avec l'option --intergrated. Si ce n'est pas le cas, modifiez la cible de celui-ci comme on vient de le faire (Clic droit > Proprits > ...).
Sous Linux
Je vais ici vous donner une manipulation simple sous Ubuntu afin de modifier la cible du lien pointant sur le logiciel dans le menu Applications . Dans le menu Systme, allez dans Prfrences puis Menu principal . gauche de la fentre qui est apparue, sous le menu Applications , cliquez sur Graphisme. Au milieu de la fentre, cliquez sur diteur de diagrammes Dia. droite, cliquez sur Proprits . Dans le champ texte Commande, placez-y dia --integrated % F. Fermez le tout, relancez votre programme via le menu et vous avez vos deux fentres fusionnes. Sous les autres distributions, l'ide est la mme : il faut vous arranger pour modifier le raccourci afin d'ajouter l'option -integrated.
Sous Mac OS
Hlas sous Mac OS, vous ne pouvez crer de raccourci. La solution consiste donc lancer le logiciel en ligne de commande. Heureusement, celle-ci est assez courte et simple retenir. En effet, un simple dia --integrated suffit. Cependant, vous pouvez tlcharger un lanceur qui vous facilitera la tche pour lancer l'application.
Cette icne, comme l'infobulle nous l'indique, reprsente l'outil permettant de crer une classe. Ainsi, dans la zone contenant notre diagramme, il suffira de cliquer n'importe o pour qu'une classe soit cre l'endroit o l'on a cliqu. Essayez donc. Normalement, vous devriez avoir obtenu quelque chose ressemblant ceci (voir figure suivante).
V ous voyez huit carrs ainsi que deux croix bleues autour de la classe. Si les carrs sont prsents, cela veut dire que la classe est slectionne (par dfaut slectionne quand vous en crez une). Si vous voulez enlever cette slection, il vous suffit de cliquer ct. V ous verrez ainsi les huit carrs remplacs par de nouvelles petites croix bleues qui ont une signification bien particulire. Je vous expliquerai ceci plus tard.
www.siteduzero.com
191/333
Fentre permettant de modifier la classe Dcortiquons un peu cette fentre. Tout ceci est en fait trs simple, il suffit juste de quelques explications. Tout en haut, vous voyez une liste de cinq onglets : Classe : permet de grer les options concernant cette classe. Attributs : permet de grer la liste des attributs de cette classe. Oprations : permet de grer la liste des mthodes de cette classe. Modles : inutile en PHP tant donn qu'il n'y a pas de templates. Si a vous intrigue, allez voir en C++ par exemple ;). Style : permet de modifier le style de la classe (couleurs et effets de texte).
www.siteduzero.com
192/333
Fentre permettant de grer les attributs Analysons le contenu de cette fentre. La partie la plus vidente que vous voyez est le gros carr blanc en haut gauche : c'est l'intrieur de ce bloc que seront lists tous les attributs. V ous pourrez, partir de l, en slectionner afin d'en modifier, d'en supprimer, d'en monter ou descendre d'un cran dans la liste. Afin d'effectuer ces actions, il vous suffira d'utiliser les boutons situs droite de ce bloc : Le bouton Nouveau crera un nouvel attribut. Le bouton Supprimer supprimera l'attribut slectionn. Le bouton Monter montera l'attribut d'un cran dans la liste (s'il n'est pas dj tout en haut). Le bouton Descendre descendra l'attribut d'un cran dans la liste (s'il n'est pas dj tout en bas). Crez donc un nouvel attribut en cliquant sur le bouton adapt. V ous voyez maintenant tous les champs du bas qui se dgrisent. Regardons de plus prs ce dont il s'agit. Un premier champ texte est prsent afin d'y spcifier le nom de l'attribut (par exemple, vous pouvez y inscrire force). En dessous est prsent un champ texte demandant le type de l'attribut (s'il s'agit d'une chane de caractres, d'un nombre entier, d'un tableau, d'un objet, etc.). Par exemple, pour l'attribut cr, vous pouvez entrer int. Ensuite vient un champ texte demandant la valeur de l'attribut. Ce n'est pas obligatoire, il faut juste y spcifier quelque chose quand on souhaite que notre attribut ait une valeur par dfaut (par exemple, vous pouvez entrer 0 ). Le dernier champ texte est utile si vous souhaitez laisser un commentaire sur l'attribut (ce que je vous conseille de faire). Vient ensuite une liste droulante permettant d'indiquer la visibilit de l'attribut. Il y a quatre options. V ous reconnatrez parmi elles les trois types de visibilits. En plus de ces trois types, vous pouvez apercevoir un quatrime type nomm Implmentation. Ne vous en proccupez pas, vous n'en aurez pas besoin. La dernire option est une case cocher, suivie de Visibilit de la classe. Si vous cochez cette case, cela voudra dire que votre attribut sera statique.
www.siteduzero.com
193/333
Entranez-vous crer quelques attributs bidons (ou bien ceux de la classe Personnage si vous tes cours d'ide). V ous pourrez ainsi tester les quatre boutons situs droite du bloc listant les attributs afin de bien comprendre leur utilisation (bien que ceci ne doit pas tre bien difficile, mais sait-on jamais ).
Fentre permettant de grer les mthodes V ous constatez dj un peu plus de bazar. Cependant, si vous observez bien et que vous avez bien suivi la prcdente partie sur la gestion des attributs, vous ne devriez pas tre entirement dpayss. En effet, en haut, nous avons toujours notre bloc blanc qui listera, cette fois-ci, nos mthodes, ainsi que les quatre boutons droite effectuant les mmes oprations. Crez donc une nouvelle mthode en cliquant simplement sur le bouton Nouveau, comme pour les attributs, et bidouillons-la un peu.
www.siteduzero.com
194/333
Zone permettant de modifier la mthode La partie encadre de rouge concerne la mthode en elle-mme. Les champs qui restent concernent ses paramtres, mais on verra a juste aprs. Les deux premiers champs textes (Nom et Type) ont le mme rle que pour les attributs (je vous rappelle que le type de la mthode est le type de la valeur renvoye par celle-ci). Ensuite est prsent un champ texte Strotype. Cela est utile pour afficher une caractristique de la mthode. Par exemple, si une mthode est finale, on mettra leaf dans ce champ. Nous avons, comme pour les attributs, deux autres options qui refont leur apparition : la visibilit et la case cocher Visibilit de la classe. Inutile de vous rappeler ce que c'est je pense (si toutefois vous avez un trou de mmoire, il vous suffit de remonter un tout petit peu dans ce cours). Et pour en finir sur les points communs avec les attributs, vous pouvez apercevoir tout droite le champ texte Commentaire qui a aussi pour rle de spcifier les commentaires relatifs la mthode. Par contre, contrairement aux attributs, nous avons ici deux nouvelles options. La premire est Type d'hritage qui est une liste droulante prsentant trois options : Abstraite : slectionner si la mthode est abstraite. Polymorphe (virtuelle) : cela ne nous concerne pas (nous travaillons avec PHP qui n'implmente pas le concept de mthode virtuelle). Feuille (finale) : slectionner si la mthode n'est ni abstraite, ni finale (contrairement ce qui est indiqu, cela ne veut pas dire que la mthode est finale !).
La deuxime option est une case cocher. ct de celle-ci est crit Requte. V ous vous demandez sans doute ce qu'une requte vient faire ici, non ? En fait, si vous cochez cette case, cela veut dire que la mthode ne modifiera aucun attribut de la classe. Par exemple, vos accesseurs (les mthodes tant charges de renvoyer la valeur d'attributs privs ou protgs) sont considrs comme de simples requtes afin d'accder ces valeurs. Elles pourront donc avoir cette case de coche. Entranez-vous crer des mthodes, il est toujours utile de pratiquer.
www.siteduzero.com
195/333
Maintenant que vous tes prts (enfin j'espre), nous allons leur ajouter des arguments. Pour cela, nous allons nous intresser cette partie de la fentre (voir la figure suivante).
Zone permettant de modifier les paramtres de la mthode Encore une fois, nous remarquons des ressemblances avec tout ce que nous avons vu. En effet, nous retrouvons notre bloc blanc ainsi que ses quatre boutons, toujours fidles au rendez-vous. Inutile de vous expliquer le rle de chacun hein je crois . Au cas o vous n'ayez pas devin, la gestion des paramtres de la mthode s'effectue cet endroit. Crez donc un nouveau paramtre. Les champs de droite, comme leur habitude, se dgrisent. Je fais une brve description des fonctionnalits des champs, tant donn que c'est du dj vu. Le champ Nom indique le nom de l'argument. Le champ Type spcifie le type de l'argument (entier, chane de caractres, tableau, etc.). Le champ Val. par df. rvle la valeur par dfaut de l'argument. Le champ Commentaire permet de laisser un petit commentaire concernant l'argument. L'option Direction est inutile.
www.siteduzero.com
196/333
Pour modifier le style de toutes les classes, slectionnez-les toutes (en cliquant sur chacune tout en maintenant la touche Shift) puis double-cliquez sur l'une d'elle. Modifiez le style dans la fentre ouverte, validez et admirez. Je crois avoir fait le tour de toutes les fonctionnalits. Pour vous entraner, vous pouvez essayer de reconstituer la classe Personnage.
Modliser un hritage
Ensuite, dirigez-vous sur la partie de droite contenant vos deux classes. Cliquez sur une croix bleue de la classe mre et, tout en maintenant le clic de la souris enfonc, glissez jusqu' une croix bleue de votre classe fille. Lorsque vous dplacez votre flche, le curseur prend la forme d'une croix. Une fois qu'il survole une croix bleue, il est transform en une autre croix reprsentant trois chemins qui se croisent, et la classe relie se voit entoure d'un pais trait rouge : c'est ce moment-l que vous pouvez lcher le clic. Normalement, vous devriez avoir obtenu ceci (voir la figure suivante).
Modlisation d'un
hritage simple
Notez les deux points rouges sur la flche ainsi que le point orange au milieu. Ceux-ci indiquent que la flche est slectionne. Il se peut que l'un des points des extrmits de la flche soit vert, auquel cas cela signifie que ce point n'est pas situ sur une croix bleue ! Si elle n'est pas sur une croix bleue, alors elle n'est relie aucune classe. Le point orange du milieu ne bougera jamais (sauf si vous le dplacez manuellement). La flche passera toujours par ce point. Ainsi, si vous voulez dplacer vos deux classes sans toucher ce point, votre flche fera une trajectoire assez trange.
Alors, premires impressions ? Si vous tes parvenus sans encombre raliser ce qu'on vient de faire, les quatre prochaines interactions seront toutes aussi simples !
Les interfaces
Passons maintenant l'implmentation d'interfaces. Crez une classe banale et, histoire que les classes coordonnent avec
www.siteduzero.com
197/333
L'icne reprsentant l'interaction de l'implmentation d'interface est situe juste gauche de celui de l'hritage (voir la figure suivante).
Comme pour la prcdente interaction, cliquez sur une des croix bleues de l'interface, puis glissez la souris sur une croix bleue de la classe l'implmentant et relchez la souris. Si tout s'est bien droul, vous devriez avoir obtenu ceci (voir figure suivante).
L'association
V oyons maintenant comment modliser l'association. Cette icne est place juste droite de l'icne reprsentant l'hritage (voir la figure suivante).
Cliquez donc sur la croix bleue de la classe ayant un attribut stockant une instance de l'autre classe, puis glissez sur cette autre classe. V ous devriez avoir ceci sous vos yeux (voir la figure suivante).
Cette fois-ci, les points rouges et le point orange n'apparaissent pas. Cela signifie simplement que la flche n'est pas slectionne.
V oyons maintenant comment dfinir l'association et placer les cardinalits. En fait, ce sont des options de l'association que l'on peut modifier en accdant la configuration de cette liaison. Pour cela, double-cliquez sur la ligne. V ous devriez avoir obtenu cette fentre (voir la figure suivante).
www.siteduzero.com
198/333
Paramtrer l'association
La dfinition de l'association se place dans le premier champ texte correspondant au nom. Mettez-y par exemple gre . Les cardinalits se placent dans les champs texte Multiplicity . La premire colonne Side A correspond la classe qui lie l'autre classe. Dans notre exemple, Side A correspond NewsManager et Side B News. Si vous vous tes bien dbrouills, vous devriez avoir obtenu quelque chose dans ce genre (voir la figure suivante).
Exemple d'une
association complte
L'agrgation
Intressons-nous maintenant la flche reprsentant l'agrgation. On peut le faire de deux faons diffrentes. La premire est la mme que la prcdente (j'entends par l que l'icne sur laquelle cliquer est la mme). Cette fois-ci, il ne faut pas afficher le sens de la liaison et afficher un losange. Pour ce faire, il suffit de slectionner Aggregation dans la liste droulante Type et cliquer sur le gros bouton Oui de la ligne Show direction. La seconde solution consiste utiliser une autre icne qui construira directement la flche avec le losange. En ralit, il s'agit simplement d'un raccourci de la premire solution. Cette icne se trouve juste droite de la prcdente (voir la figure suivante).
www.siteduzero.com
199/333
La composition
Enfin, terminons par la composition. La composition n'a pas d'icne pour la reprsenter. V ous pouvez soit cliquer sur l'icne de l'association, soit cliquer sur l'icne de l'agrgation (cette dernire est prfrer dans le sens o une composition se rapproche beaucoup plus d'une agrgation que d'une association). Reliez vos classes comme nous l'avons fait jusqu' maintenant puis double-cliquez sur celles-ci. Nous allons regarder la mme liste droulante que celle utilise dans l'agrgation : je parle de la liste droulante Type. l'intrieur de celle-ci, choisissez l'option Composition puis validez.
Exercice
V ous avez dsormais accumul toutes les connaissances pour faire un diagramme complet. Je vais donc vous demander de me reconstituer le diagramme que je vous ai donn au dbut (voir la figure suivante).
Avant toute exportation, il faut sauvegarder son diagramme, sinon cela ne fonctionnera pas. Pour ce faire, cliquez sur le menu Fichier puis cliquez sur Enregistrer (voir la figure suivante).
www.siteduzero.com
200/333
Ou cliquez sur cette icne (voir la figure suivante). Enregistrer le diagramme par la barre d'outils
Fentre permettant d'enregistrer le diagramme Tout est crit en franais, je ne pense pas avoir besoin d'expliquer en dtails. Cette fentre contient un explorateur. gauche sont lists les raccourcis menant aux dossiers les plus courants (le bureau, les documents, ainsi que les disques), tandis qu' droite sont lists tous les fichiers et dossiers prsents dans celui o vous vous trouvez (dans mon cas, le dossier est vierge).
www.siteduzero.com
201/333
Le champ texte situ tout en haut contient le nom du fichier sous lequel doit tre enregistr le diagramme. Une fois que vous avez bien tout paramtr, cliquez sur Enregistrer. V otre diagramme est maintenant enregistr au format .dia.
Ou cliquez sur cette icne (voir la figure suivante). Exporter le diagramme par la barre d'outils
Une fentre semblable celle de l'enregistrement du diagramme apparat. Cependant, il y a une liste droulante qui a fait son apparition (voir la figure suivante).
Dterminer le type du fichier Pour exporter votre diagramme sous forme d'image, vous avez deux possibilits. Soit vous placez l'extension .png la fin du nom de votre image en haut, soit, dans la liste droulante, vous slectionnez l'option Pixbuf[png] (*.png). Avec cette deuxime solution, le champ texte du haut contiendra le nom de votre image avec l'extension .png . Cliquez sur Enregistrer, puis contemplez votre image gnre. Pas mal, n'est-ce pas ?
www.siteduzero.com
202/333
Dans la premire liste droulante, choisissez UML-CLASSES-EXTENDED. Dans la seconde liste, choisissez PHP5 puis cliquez sur Valider. Regardez les nouveaux fichiers gnrs dans votre dossier. Alors, a en jette non ? Si vous n'avez pas l'option UML-CLASSES-EXTENDED c'est que vous n'avez pas install comme il faut l'extension uml2php5 . Relisez donc bien la premire partie du cours.
En rsum
Dia est un logiciel permettant de crer facilement des diagrammes UML. Ce logiciel a l'avantage de pouvoir exporter vos diagrammes en images et en codes PHP. La modlisation grce UML est trs apprcie dans le milieu professionnel, n'en ayez pas peur !
www.siteduzero.com
203/333
Dans votre script, vous pourrez donc faire quelque chose de ce genre : Code : PHP <?php try { $mysql = DBFactory::load('MySQL'); } catch (RuntimeException $e) { echo $e->getMessage(); }
www.siteduzero.com
204/333
Exemple concret
Le but est de crer une classe qui nous distribuera les objets PDO plus facilement. Nous allons partir du principe que vous avez plusieurs SGBDR, ou plusieurs BDD qui utilisent des identifiants diffrents. Pour rsumer, nous allons tout centraliser dans une classe. Code : PHP <?php class PDOFactory { public static function getMysqlConnexion() { $db = new PDO('mysql:host=localhost;dbname=tests', 'root', ''); $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); } return $db;
public static function getPgsqlConnexion() { $db = new PDO('pgsql:host=localhost;dbname=tests', 'root', ''); $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); } return $db;
} ?>
Ceci vous simplifiera normment la tche. Si vous avez besoin de modifier vos identifiants de connexion, vous n'aurez pas aller chercher dans tous vos scripts : tout sera plac dans notre factory.
www.siteduzero.com
205/333
L'interface SplObserver est l'interface implmente par les diffrents observateurs. Elle ne contient qu'une seule mthode qui est celle appele par la classe observe dans la mthode notify() : il s'agit de update ( (SplSubject $subject)). V oici un diagramme mettant en uvre ce design pattern (voir la figure suivante).
Diagramme modlisant une mise en place du design pattern Observer Nous allons maintenant imaginer le code correspondant au diagramme. Commenons par la classe observe : Code : PHP - Classe observe <?php class Observee implements SplSubject { // Ceci est le tableau qui va contenir tous les objets qui nous observent. protected $observers = array(); // Ds que cet attribut changera on notifiera les classes observatrices. protected $nom; public function attach(SplObserver $observer) { $this->observers[] = $observer; } public function detach(SplObserver $observer) { if (is_int($key = array_search($observer, $this->observers, true))) { unset($this->observers[$key]); } } public function notify() { foreach ($this->observers as $observer) { $observer->update($this); } } public function getNom() { return $this->nom; } public function setNom($nom)
www.siteduzero.com
206/333
} ?>
V ous pouvez constater la prsence du nom des interfaces en guise d'argument. Cela signifie que cet argument doit implmenter l'interface spcifie.
V oici les deux classes observatrices : Code : PHP - Classes observatrices <?php class Observer1 implements SplObserver { public function update(SplSubject $obj) { echo __CLASS__, ' a t notifi ! Nouvelle valeur de l\'attribut <strong>nom</strong> : ', $obj->getNom(); } } class Observer2 implements SplObserver { public function update(SplSubject $obj) { echo __CLASS__, ' a t notifi ! Nouvelle valeur de l\'attribut <strong>nom</strong> : ', $obj->getNom(); } } ?>
Ces deux classes font exactement la mme chose, ce n'tait qu' titre d'exemple basique que je vous ai donn ces exemples, afin que vous puissiez vous rendre compte de la syntaxe de base lors de l'utilisation du pattern Observer. Pour tester nos classes, vous pouvez utiliser ce bout de code : Code : PHP <?php $o = new Observee; $o->attach(new Observer1); // Ajout d'un observateur. $o->attach(new Observer2); // Ajout d'un autre observateur. $o->setNom('Victor'); // On modifie le nom pour voir si les classes observatrices ont bien t notifies. ?>
V ous pouvez constater qu'ajouter des classes observatrices de cette faon peut tre assez long si on en a cinq ou six. Il y a une petite technique qui consiste pouvoir obtenir ce genre de code : Code : PHP <?php $o = new Observee;
www.siteduzero.com
207/333
$o->setNom('Victor'); // On modifie le nom pour voir si les classes observatrices ont bien t notifies. ?>
Pour effectuer ce genre de manuvres, la mthode attach() doit retourner l'instance qui l'a appel (en d'autres termes, elle doit retourner $this).
Exemple concret
Regardons un exemple concret prsent. Nous allons imaginer que vous avez, dans votre script, une classe grant les erreurs gnres par PHP. Lorsqu'une erreur est gnre, vous aimeriez qu'il se passe deux choses : Que l'erreur soit enregistre en BDD. Que l'erreur vous soit envoye par mail.
Pour cela, vous pensez donc coder une classe comportant une mthode attrapant l'erreur et effectuant les deux oprations cidessus. Grave erreur ! Ceci est surtout viter : votre classe est charge d'intercepter les erreurs, et non de les grer ! Ce sera d'autres classes de s'en occuper : ces classes vont observer la classe grant l'erreur et une fois notifie, elles vont effectuer l'action pour laquelle elles ont t conues. V ous voyez un peu la tte qu'aura le script ? Rappel : pour intercepter les erreurs, il vous faut utiliser set_error_handler(). Pour faire en sorte que la fonction de callback appele lors de la gnration d'une erreur soit une mthode d'une classe, passez un tableau deux entres en premier argument. La premire entre est l'objet sur lequel vous allez appeler la mthode, et la seconde est le nom de la mthode.
www.siteduzero.com
208/333
public function getFormatedError() { return $this->formatedError; } public function notify() { foreach ($this->observers as $observer) { $observer->update($this); } } public function error($errno, $errstr, $errfile, $errline) { $this->formatedError = '[' . $errno . '] ' . $errstr . "\n" . 'Fichier : ' . $errfile . ' (ligne ' . $errline . ')'; $this->notify(); } } ?>
www.siteduzero.com
209/333
D'accord, cela en fait du code ! Je ne sais pas si vous vous en rendez compte, mais ce que nous venons de crer l est une excellente manire de coder. Nous venons de sparer notre code comme il se doit et nous pourrons le modifier aisment car les diffrentes actions ont t spares avec logique.
Exemple concret
www.siteduzero.com
210/333
Passons directement l'exemple concret. Nous allons suivre l'ide que nous avons voque l'instant : l'action d'crire dans un fichier ou dans une BDD. Il y aura pas mal de classes crer donc au lieu de vous faire un grand discours, je vais dtailler le diagramme reprsentant l'application (voir la figure suivante).
Diagramme modlisant une mise en place du design pattern Strategy a en fait des classes ! Pourtant (je vous assure) le principe est trs simple comprendre. La classe Writer est abstraite (a n'aurait aucun sens de l'instancier : on veut crire, d'accord, mais sur quel support ?) et implmente un constructeur qui acceptera un argument : il s'agit du formateur que l'on souhaite utiliser. Nous allons aussi placer une mthode abstraite write(), ce qui forcera toutes les classes filles de Writer implmenter cette mthode qui appellera la mthode format() du formateur associ (instance contenue dans l'attribut $formater) afin de rcuprer le texte format. Allez, au boulot ! Commenons par l'interface. Rien de bien compliqu, elle ne contient qu'une seule mthode : Code : PHP - Formater.interface.php <?php interface Formater { public function format($text); } ?>
Ensuite vient la classe abstraite Writer que voici : Code : PHP - Writer.class.php <?php abstract class Writer { // Attribut contenant l'instance du formateur que l'on veut utiliser. protected $formater; abstract public function write($text); // Nous voulons une instance d'une classe implmentant Formater en paramtre. public function __construct(Formater $formater) {
www.siteduzero.com
211/333
} ?>
Nous allons maintenant crer deux classes hritant de Writer : FileWriter et DBWriter. Code : PHP - DBWriter.class.php <?php class DBWriter extends Writer { protected $db; public function __construct(Formater $formater, PDO $db) { parent::__construct($formater); $this->db = $db; } public function write ($text) { $q = $this->db->prepare('INSERT INTO lorem_ipsum SET text = :text'); $q->bindValue(':text', $this->formater->format($text)); $q->execute(); } } ?>
Code : PHP - FileWriter.class.php <?php class FileWriter extends Writer { // Attribut stockant le chemin du fichier. protected $file; public function __construct(Formater $formater, $file) { parent::__construct($formater); $this->file = $file; } public function write($text) { $f = fopen($this->file, 'w'); fwrite($f, $this->formater->format($text)); fclose($f); }
} ?>
Enfin, nous avons nos trois formateurs. L'un ne fait rien de particulier (TextFormater), et les deux autres formatent le texte en deux langages diffrents (HTMLFormater et XMLFormater). J'ai dcid d'ajouter le timestamp dans le formatage du texte histoire que le code ne soit pas compltement inutile (surtout pour la classe qui ne fait pas de formatage particulier). Code : PHP - TextFormater.class.php <?php
www.siteduzero.com
212/333
Code : PHP - HTMLFormater.class.php <?php class HTMLFormater implements Formater { public function format($text) { return '<p>Date : ' . time() . '<br />' ."\n". 'Texte : ' . $text . '</p>'; } } ?>
Code : PHP - XMLFormater.class.php <?php class XMLFormater implements Formater { public function format($text) { return '<?xml version="1.0" encoding="ISO-8859-1"?>' ."\n". '<message>' ."\n". "\t". '<date>' . time() . '</date>' ."\n". "\t". '<texte>' . $text . '</texte>' ."\n". '</message>'; } } ?>
Et testons enfin notre code : Code : PHP - index.php <?php function autoload($class) { if (file_exists($path = $class . '.class.php') || file_exists($path = $class . '.interface.php')) { require $path; } } spl_autoload_register('autoload'); $writer = new FileWriter(new HTMLFormater, 'file.html'); $writer->write('Hello world !'); ?>
Ce code de base a l'avantage d'tre trs flexible. Il peut paratre un peu imposant pour notre utilisation, mais si l'application est
www.siteduzero.com
213/333
Le problme
Nous avons une classe qui ne doit tre instancie qu'une seule fois. premire vue, a vous semble impossible et c'est normal. Jusqu' prsent, nous pouvions faire de multiples $obj = new Classe; jusqu' l'infini, et nous nous retrouvions avec une infinit d'instances de Classe. Il va donc falloir empcher ceci. Pour empcher la cration d'une instance de cette faon, c'est trs simple : il suffit de mettre le constructeur de la classe en priv ou en protg ! T'es marrant toi, on ne pourra jamais crer d'instance avec cette technique !
Bien sr que si ! Nous allons crer une instance de notre classe l'intrieur d'elle-mme ! De cette faon nous aurons accs au constructeur. Oui mais voil, il ne va falloir crer qu'une seule instance... Nous allons donc crer un attribut statique dans notre classe qui contiendra... l'instance de cette classe ! Nous aurons aussi une mthode statique qui aura pour rle de renvoyer cette instance. Si on l'appelle pour la premire fois, alors il faut instancier la classe puis retourner l'objet, sinon on se contente de le retourner.
Il reste un petit dtail rgler. Nous voulons vraiment une seule instance, et l, il est encore possible d'en avoir plusieurs. En effet, rien n'empche l'utilisateur de cloner l'instance ! Il faut donc bien penser interdire l'accs la mthode __clone(). Ainsi, une classe implmentant le pattern Singleton ressemblerait ceci : Code : PHP <?php class MonSingleton { protected static $instance; // Contiendra l'instance de notre classe. protected function __construct() { } // Constructeur en priv. protected function __clone() { } // Mthode de clonage en priv aussi. public static function getInstance() { if (!isset(self::$instance)) // Si on n'a pas encore instanci notre classe. { self::$instance = new self; // On s'instancie nous-mmes. :) } } return self::$instance;
} ?>
Ceci est le strict minimum. vous d'implmenter de nouvelles mthodes comme vous l'auriez fait dans votre classe normale. V oici donc une utilisation de la classe :
www.siteduzero.com
214/333
Exemple concret
Un exemple concret pour le pattern Singleton ? Non, dsol, nous allons devoir nous en passer. Quoi ? Tu te moques de nous ? Alors il sert rien ce design pattern ?
Selon moi, non. Je n'ai encore jamais eu besoin de l'utiliser. Ce pattern doit tre employ uniquement si plusieurs instanciations de la classe provoquaient un dysfonctionnement. Si le script peut continuer normalement alors que plusieurs instances sont cres, le pattern Singleton ne doit pas tre utilis. Donc ce que nous avons appris l, a ne sert rien ?
Non. Il est important de connatre ce design pattern, non pas pour l'utiliser, mais au contraire pour ne pas y avoir recours, et surtout savoir pourquoi. Cependant, avant de vous rpondre, je vais vous prsenter un autre pattern trs important : l'injection de dpendances .
L'injection de dpendances
Comme tout pattern, celui-ci est n cause d'un problme souvent rencontr par les dveloppeurs : le fait d'avoir de nombreuses classes dpendantes les unes des autres. L'injection de dpendances consiste dcoupler nos classes. Le pattern singleton que nous venons de voir favorise les dpendances, et l'injection de dpendances palliant ce problme, il est intressant d'tudier ce nouveau pattern avec celui que nous venons de voir. Soit le code suivant : Code : PHP <?php class NewsManager { public function get($id) { // On admet que MyPDO tend PDO et qu'il implmente un singleton. $q = MyPDO::getInstance()->query('SELECT id, auteur, titre, contenu FROM news WHERE id = '.(int)$id); } return $q->fetch(PDO::FETCH_ASSOC);
V ous vous apercevez qu'ici, le singleton a introduit une dpendance entre deux classes n'appartenant pas au mme module. Deux modules ne doivent jamais tre lis de cette faon, ce qui est le cas dans cet exemple. Deux modules doivent tre indpendants l'un de l'autre. D'ailleurs, en y regardant de plus prs, cela ressemble fortement une variable globale. En effet, un singleton n'est rien d'autre qu'une variable globale dguise (il y a juste une tape en plus pour accder la variable) : Code : PHP <?php
www.siteduzero.com
215/333
V ous ne voyez pas o est le problme ? Souvenez-vous de l'un des points forts de la POO : le fait de pouvoir redistribuer sa classe ou la rutiliser. Dans le cas prsent, c'est impossible, car notre classe NewsManager dpend de MyPDO. Qu'est-ce qui vous dit que la personne qui utilisera NewsManager aura cette dernire ? Rien du tout, et c'est normal. Nous sommes ici face une dpendance cre par le singleton. De plus, la classe dpend aussi de PDO : il y avait donc dj une dpendance au dbut, et le pattern Singleton en a cr une autre. Il faut donc supprimer ces deux dpendances. Comment faire alors ?
Ce qu'il faut, c'est passer notre DAO au constructeur, sauf que notre classe ne doit pas tre dpendante d'une quelconque bibliothque. Ainsi, notre objet peut trs bien utiliser PDO, MySQLi ou que sais-je encore, la classe se servant de lui doit fonctionner de la mme manire. Alors comment procder ? Il faut imposer un comportement spcifique notre objet en l'obligeant implmenter certaines mthodes. Je ne vous fais pas attendre : les interfaces sont l pour a. Nous allons donc crer une interface iDB contenant (pour faire simple) qu'une seule mthode : query(). Code : PHP <?php interface iDB { public function query($query); }
Pour que l'exemple soit parlant, nous allons crer deux classes utilisant cette structure, l'une utilisant PDO et l'autre MySQLi. Cependant, un problme se pose : le rsultat retourn par la mthode query() des classes PDO et MySQLi sont des instances de deux classes diffrentes, les mthodes disponibles ne sont, par consquent, pas les mmes. Il faut donc crer d'autres classes pour grer les rsultats qui suivent eux aussi une structure dfinie par une interface (admettons iResult). Code : PHP <?php interface iResult { public function fetchAssoc(); }
Nous pouvons donc prsent crire nos quatre classes : MyPDO, MyMySQLi, MyPDOStatement et MyMySQLiResult. Code : PHP - MyPDO <?php class MyPDO extends PDO implements iDB { public function query($query) { return new MyPDOStatement(parent::query($query)); }
www.siteduzero.com
216/333
Code : PHP - MyPDOStatement <?php class MyPDOStatement implements iResult { protected $st; public function __construct(PDOStatement $st) { $this->st = $st; } public function fetchAssoc() { return $this->st->fetch(PDO::FETCH_ASSOC); }
Code : PHP - MyMySQLi <?php class MyMySQLi extends MySQLi implements iDB { public function query($query) { return new MyMySQLiResult(parent::query($query)); } }
Code : PHP - MyMySQLiResult <?php class MyMySQLiResult implements iResult { protected $st; public function __construct(MySQLi_Result $st) { $this->st = $st; } public function fetchAssoc() { return $this->st->fetch_assoc(); }
Nous pouvons donc maintenant crire notre classe NewsManager. N'oubliez pas de vrifier que les objets sont bien des instances de classes implmentant les interfaces dsires. Code : PHP <?php class NewsManager { protected $dao; // On souhaite un objet instanciant une classe qui implmente
www.siteduzero.com
217/333
Testons maintenant notre code. Code : PHP <?php $dao = new MyPDO('mysql:host=localhost;dbname=news', 'root', ''); // $dao = new MyMySQLi('localhost', 'root', '', 'news'); $manager = new NewsManager($dao); print_r($manager->get(2));
Je vous laisse commenter les deux premires lignes pour vrifier que les deux fonctionnent. Aprs quelques tests, vous vous rendrez compte que nous avons bel et bien dcoupl nos classes ! Il n'y a ainsi plus aucune dpendance entre notre classe NewsManager et une quelconque autre classe. Le problme, dans notre cas, c'est qu'il est difficile de faire de l'injection de dpendances pour qu'une classe supporte toutes les bibliothques d'accs aux BDD (PDO, MySQLi, etc.) cause des rsultats des requtes. De son ct, PDO a la classe PDOStatement, tandis que MySQLi a MySQLi_STMT pour les requtes prpares et MySQLi_Result pour les rsultats de requtes classiques. Cela est donc difficile de les conformer au mme modle. Nous allons donc, dans le TP venir, utiliser une autre technique pour dcoupler nos classes.
Pour conclure
Le principal problme du singleton est de favoriser les dpendances entre deux classes. Il faut donc tre trs mfiant de ce ctl, car votre application deviendra difficilement modifiable et l'on perd alors les avantages de la POO. Je vous recommande donc d'utiliser le singleton en dernier recours : si vous dcidez d'implmenter ce pattern, c'est pour garantir que cette classe ne doit tre instancie qu'une seule fois. Si vous vous rendez compte que deux instances ou plus ne causent pas de problme l'application, alors n'implmentez pas le singleton. Et par piti : n'implmentez pas un singleton pour l'utiliser comme une variable globale ! C'est la pire des choses faire car cela favorise les dpendances entre classes comme nous l'avons vu. Si vous voulez en savoir plus sur l'injection de dpendances (notamment sur l'utilisation de conteneurs ), je vous invite lire cet excellent tutoriel de vincent1870.
En rsum
Un design pattern est un moyen de conception rpondant un problme rcurrent. Le pattern factory a pour but de laisser des classes usine crer les instances votre place.
www.siteduzero.com
218/333
Le pattern observer permet de lier certains objets des couteurs eux-mmes chargs de notifier les objets auxquels ils sont rattachs. Le pattern strategy sert dlocaliser la partie algorithmique d'une mthode afin de le permettre rutilisable, vitant ainsi la duplication de cet algorithme. Le pattern singleton permet de pouvoir instancier une classe une seule et unique fois, ce qui prsente quelques soucis au niveau des dpendances entre classes. Le pattern injection de dpendances a pour but de rendre le plus indpendantes possible les classes.
www.siteduzero.com
219/333
TP : un systme de news
La plupart des sites web dynamiques proposent un systme d'actualits. Je sais par consquent que c'est l'exemple auquel la plupart d'entre vous s'attend : nous allons donc raliser ici un systme de news ! Cela sera le dernier petit TP permettant de clarifier vos acquis avant celui plus important qui vous attend. Ce TP est aussi l'occasion pour vous de voir un exemple concret qui vous sera utile pour votre site !
Concernant l'organisation des classes, nous allons suivre la mme structure que pour les personnages, savoir : Une classe News qui contiendra les champs sous forme d'attributs. Son rle sera de reprsenter une news. Une classe NewsManager qui grera les news. C'est elle qui interagira avec la BDD. Cependant, je voudrais vous enseigner quelque chose de nouveau. Je voudrais que la classe NewsManager ne soit pas dpendante de PDO. Nous avons vu dans le chapitre prcdent que l'injection de dpendances pouvait tre intressante mais nous compliquait trop la tche concernant l'adaptation des DAO. Au lieu d'injecter la dpendance, nous allons plutt crer des classes spcialises , c'est--dire qu' chaque API correspondra une classe. Par exemple, si nous voulons assurer la compatibilit de notre systme de news avec l'API PDO et MySQLi, alors nous aurons deux managers diffrents, l'un effectuant les requtes avec PDO, l'autre avec MySQLi. Nanmoins, tant donn que ces classes ont une nature en commun (celle d'tre toutes les deux des managers de news), alors elles devront hriter d'une classe reprsentant cette nature.
www.siteduzero.com
220/333
Comme vous pouvez le constater, on rcupre la liste des personnages sous forme de tableau grce la constante PDO::FETCH_ASSOC, puis on instancie notre classe Personnage en passant ce tableau au constructeur. Je vais vous dvoiler un moyen plus simple et davantage optimis pour effectuer cette opration. je ne l'ai pas abord prcdemment car je trouvais qu'il tait un peu tt pour vous en parler ds la premire partie. Avec PDO (comme avec MySQLi, mais nous le verrons plus tard), il existe une constante qui signifie retourne-moi le rsultat dans un objet (au mme titre que la constante PDO::FETCH_ASSOC signifie retourne-moi le rsultat dans un tableau ). Cette constante est tout simplement PDO::FETCH_CLASS. Comment s'utilise-t-elle ? Comme vous vous en doutez peut-tre, si nous voulons que PDO nous retourne les rsultats sous forme d'instances de notre classe News, il va falloir lui dire ! Or, nous ne pouvons pas lui dire le nom de notre classe directement dans la mthode fetch() comme nous le faisons avec PDO::FETCH_ASSOC. Nous allons nous servir d'une autre mthode, setFetchMode(). Si vous avez lu les toutes premires lignes de la page pointe par le lien que j'ai donn, vous devriez savoir utiliser cette mthode : Code : PHP <?php // On admet que $db est une instance de PDO $q = $db->prepare('SELECT id, nom, degats FROM personnages WHERE nom <> :nom ORDER BY nom'); $q->execute(array(':nom' => $nom)); $q->setFetchMode(PDO::FETCH_CLASS, 'Personnage'); $persos = $q->fetchAll();
Notez qu'il n'est plus utile de parcourir chaque rsultat pour les stocker dans un tableau puisque nous n'avons aucune opration effectuer. Un simple appel fetchAll() suffit donc amplement.
Comme vous le voyez, puisque nous avons dit PDO la ligne 7 que nous voulions une instance de Personnage en guise de rsultat, il n'est pas utile de spcifier de nouveau quoi que ce soit lorsqu'on appelle la mthode fetchAll(). V ous pouvez essayer ce code et vous verrez que a fonctionne. Maintenant, je vais vous demander d'effectuer un petit test. Affichez la valeur des attributs dans le constructeur de News (avec des simples echo, n'allez pas chercher bien loin). Lancez de nouveau le script. Sur votre cran vont alors s'afficher les valeurs que PDO a assignes notre objet. Rien ne vous titille ? Doisje vous rappeler que, normalement, le constructeur d'une classe est appel en premier et qu'il a pour rle principal d'initialiser l'objet ? Pensez-vous que ce rle est accompli alors que les valeurs ont t assignes avant mme que le constructeur soit appel ? Si vous aviez un constructeur qui devait assigner des valeurs par dfaut aux attributs, celui-ci aurait cras les valeurs assignes par PDO. Pour rsumer, mmorisez qu'avec cette technique, l'objet n'est pas instanci comme il se doit. L'objet est cr (sans que le constructeur soit appel), puis les valeurs sont assignes aux attributs par PDO, enfin le constructeur est appel. Pour remettre les choses dans l'ordre, une autre constante est disponible : PDO::FETCH_PROPS_LATE. Elle va de paire avec PDO::FETCH_CLASS. Essayez ds prsent cette modification : Code : PHP
www.siteduzero.com
221/333
Affichez avec des echo la valeur de quelques attributs dans le constructeur et vous verrez qu'ils auront tous une valeur nulle, pour la simple et bonne raison que cette fois-ci, le constructeur a t appel avant que les valeurs soient assignes aux attributs par PDO. Maintenant, puisque le cahier des charges vous demande de rendre ce script compatible avec l'API MySQLi, je vais vous dire comment procder. C'est beaucoup plus simple : au lieu d'appeler la mthode fetch_assoc() sur le rsultat, appelez tout simplement la mthode fetch_object('NomDeLaClasse'). Mes attributs sont privs ou protgs, pourquoi PDO et MySQLi peuvent-ils modifier leur valeur sans appeler les setters ? Procder de cette faon, c'est de la "bidouille" de bas niveau. PDO et MySQLi sont des API compiles avec PHP, elles ne fonctionnent donc pas comme les classes que vous dveloppez. En plus de vous dire des btises, cela serait un hors sujet de vous expliquer le pourquoi du comment, mais sachez juste que les API compiles ont quelques super pouvoirs de ce genre.
Le code du systme
www.siteduzero.com
222/333
www.siteduzero.com
223/333
www.siteduzero.com
224/333
Code : PHP - NewsManager.class.php <?php abstract class NewsManager { /** * Mthode permettant d'ajouter une news. * @param $news News La news ajouter * @return void */ abstract protected function add(News $news); /** * Mthode renvoyant le nombre de news total. * @return int */ abstract public function count(); /** * Mthode permettant de supprimer une news. * @param $id int L'identifiant de la news supprimer * @return void */
www.siteduzero.com
225/333
Code : PHP - NewsManager_PDO.class.php <?php class NewsManager_PDO extends NewsManager { /** * Attribut contenant l'instance reprsentant la BDD. * @type PDO */ protected $db; /** * Constructeur tant charg d'enregistrer l'instance de PDO dans l'attribut $db. * @param $db PDO Le DAO * @return void */ public function __construct(PDO $db) { $this->db = $db; }
www.siteduzero.com
226/333
/** * @see NewsManager::count() */ public function count() { return $this->db->query('SELECT COUNT(*) FROM news')>fetchColumn(); } /** * @see NewsManager::delete() */ public function delete($id) { $this->db->exec('DELETE FROM news WHERE id = '.(int) $id); } /** * @see NewsManager::getList() */ public function getList($debut = -1, $limite = -1) { $sql = 'SELECT id, auteur, titre, contenu, DATE_FORMAT (dateAjout, \'le %d/%m/%Y %Hh%i\') AS dateAjout, DATE_FORMAT (dateModif, \'le %d/%m/%Y %Hh%i\') AS dateModif FROM news ORDER BY id DESC'; // On vrifie l'intgrit des paramtres fournis. if ($debut != -1 || $limite != -1) { $sql .= ' LIMIT '.(int) $limite.' OFFSET '.(int) $debut; } $requete = $this->db->query($sql); $requete->setFetchMode(PDO::FETCH_CLASS | PDO::FETCH_PROPS_LATE, 'News'); $listeNews = $requete->fetchAll(); $requete->closeCursor(); } return $listeNews;
/** * @see NewsManager::getUnique() */ public function getUnique($id) { $requete = $this->db->prepare('SELECT id, auteur, titre, contenu, DATE_FORMAT (dateAjout, \'le %d/%m/%Y %Hh%i\') AS dateAjout, DATE_FORMAT (dateModif, \'le %d/%m/%Y %Hh%i\') AS dateModif FROM news WHERE id = :id'); $requete->bindValue(':id', (int) $id, PDO::PARAM_INT);
www.siteduzero.com
227/333
/** * @see NewsManager::update() */ protected function update(News $news) { $requete = $this->db->prepare('UPDATE news SET auteur = :auteur, titre = :titre, contenu = :contenu, dateModif = NOW() WHERE id = :id'); $requete->bindValue(':titre', $news->titre()); $requete->bindValue(':auteur', $news->auteur()); $requete->bindValue(':contenu', $news->contenu()); $requete->bindValue(':id', $news->id(), PDO::PARAM_INT); } $requete->execute();
Code : PHP - NewsManager_MySQLi.class.php <?php class NewsManager_MySQLi extends NewsManager { /** * Attribut contenant l'instance reprsentant la BDD. * @type MySQLi */ protected $db; /** * Constructeur tant charg d'enregistrer l'instance de MySQLi dans l'attribut $db. * @param $db MySQLi Le DAO * @return void */ public function __construct(MySQLi $db) { $this->db = $db; } /** * @see NewsManager::add() */ protected function add(News $news) { $requete = $this->db->prepare('INSERT INTO news SET auteur = ?, titre = ?, contenu = ?, dateAjout = NOW(), dateModif = NOW()'); $requete->bind_param('sss', $news->auteur(), $news->titre(), $news->contenu()); } $requete->execute();
/** * @see NewsManager::count() */ public function count() { return $this->db->query('SELECT id FROM news')->num_rows;
www.siteduzero.com
228/333
/** * @see NewsManager::getList() */ public function getList($debut = -1, $limite = -1) { $listeNews = array(); $sql = 'SELECT id, auteur, titre, contenu, DATE_FORMAT (dateAjout, \'le %d/%m/%Y %Hh%i\') AS dateAjout, DATE_FORMAT (dateModif, \'le %d/%m/%Y %Hh%i\') AS dateModif FROM news ORDER BY id DESC'; // On vrifie l'intgrit des paramtres fournis. if ($debut != -1 || $limite != -1) { $sql .= ' LIMIT '.(int) $limite.' OFFSET '.(int) $debut; } $requete = $this->db->query($sql); while ($news = $requete->fetch_object('News')) { $listeNews[] = $news; } } return $listeNews;
/** * @see NewsManager::getUnique() */ public function getUnique($id) { $id = (int) $id; $requete = $this->db->prepare('SELECT id, auteur, titre, contenu, DATE_FORMAT (dateAjout, \'le %d/%m/%Y %Hh%i\') AS dateAjout, DATE_FORMAT (dateModif, \'le %d/%m/%Y %Hh%i\') AS dateModif FROM news WHERE id = ?'); $requete->bind_param('i', $id); $requete->execute(); $requete->bind_result($id, $auteur, $titre, $contenu, $dateAjout, $dateModif); $requete->fetch(); return new News(array( 'id' => $id, 'auteur' => $auteur, 'titre' => $titre, 'contenu' => $contenu, 'dateAjout' => $dateAjout, 'dateModif' => $dateModif
www.siteduzero.com
229/333
/** * @see NewsManager::update() */ protected function update(News $news) { $requete = $this->db->prepare('UPDATE news SET auteur = ?, titre = ?, contenu = ?, dateModif = NOW() WHERE id = ?'); $requete->bind_param('sssi', $news->auteur(), $news->titre(), $news->contenu(), $news->id()); } $requete->execute();
Pour accder aux instances de PDO et MySQLi, nous allons nous aider du design pattern factory. Veuillez donc crer une simple classe DBFactory. Code : PHP - DBFactory.class.php <?php class DBFactory { public static function getMysqlConnexionWithPDO() { $db = new PDO('mysql:host=localhost;dbname=news', 'root', ''); $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); } return $db;
public static function getMysqlConnexionWithMySQLi() { return new MySQLi('localhost', 'root', '', 'news'); }
Nous allons crer deux pages : index.php qui sera accessible au grand public et listera les news, ainsi que admin.php qui nous permettra de grer les news. Dans ces deux pages, nous aurons besoin d'un autoload. Nous allons donc crer un fichier autoload.inc.php dans le dossier lib qui contiendra notre autoload. Il s'agit d'un simple fichier, voyez par vous-mme : Code : PHP - autoload.inc.php <?php function autoload($classname) { if (file_exists($file = dirname (__FILE__) . '/' . $classname . '.class.php')) { require $file; } } spl_autoload_register('autoload');
Maintenant que nous avons cr la partie interne, nous allons nous occuper des pages qui s'afficheront devant vos yeux. Il s'agit bien entendu de la partie la plus facile, le pire est derrire nous.
www.siteduzero.com
230/333
www.siteduzero.com
231/333
www.siteduzero.com
232/333
Et enfin, la partie visible tous vos visiteurs : Code : PHP - index.php <?php require 'lib/autoload.inc.php'; $db = DBFactory::getMysqlConnexionWithMySQLi(); $manager = new NewsManager_MySQLi($db); ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr"> <head> <title>Accueil du site</title> <meta http-equiv="Content-type" content="text/html; charset=iso8859-1" /> </head> <body> <p><a href="admin.php">Accder l'espace d'administration</a></p> <?php if (isset($_GET['id'])) { $news = $manager->getUnique((int) $_GET['id']); echo '<p>Par <em>', $news->auteur(), '</em>, ', $news>dateAjout(), '</p>', "\n", '<h2>', $news->titre(), '</h2>', "\n", '<p>', nl2br($news->contenu()), '</p>', "\n"; if ($news->dateAjout() != $news->dateModif()) { echo '<p style="text-align: right;"><small><em>Modifie ', $news->dateModif(), '</em></small></p>'; } } else { echo '<h2 style="text-align:center">Liste des 5 dernires news</h2>'; foreach ($manager->getList(0, 5) as $news) { if (strlen($news->contenu()) <= 200) { $contenu = $news->contenu(); } else { $debut = substr($news->contenu(), 0, 200); $debut = substr($debut, 0, strrpos($debut, ' ')) . '...'; } $contenu = $debut;
echo '<h4><a href="?id=', $news->id(), '">', $news->titre(), '</a></h4>', "\n", '<p>', nl2br($contenu), '</p>'; } }
www.siteduzero.com
233/333
www.siteduzero.com
234/333
Description de l'application
Il serait temps de faire un TP consquent pour mettre en pratique tout ce que nous avons vu : nous allons raliser un site web (souvent compar une application). En effet, vous avez maintenant toutes les connaissances ncessaires pour raliser une tel projet. Ce sera donc l'occasion de faire un point sur vos connaissances en orient objet. Si vous pensez que vous tes l'aise avec l'orient objet, ce TP sera l'occasion de vrifier cela. Si vous avez toujours du mal, alors ce TP vous aidera de faon trs concrte. Pour y arriver, nous allons crer une bibliothque (terme que nous allons dfinir ds ce premier chapitre), un module de news avec commentaires ainsi qu'un espace d'administration complet. Le plus difficile consiste dvelopper notre bibliothque. Au lieu de nous lancer tte baisse dans sa cration, nous allons rflchir sur ce que c'est, quoi elle doit nous servir, etc. Nous ne dvelopperons cette bibliothque que dans le prochain chapitre. Ceci est une tape importante qu'il ne faut surtout pas ngliger. Ne lisez donc pas ce chapitre vite fait, bien fait , sinon vous risquez d'tre perdus par la suite. Par ailleurs, ne vous dcouragez pas si vous ne comprenez pas tout d'un coup : ce chapitre est d'un niveau plus lev que les prcdents, il est donc normal de ne pas tout comprendre ds la premire lecture. Ne vous dcouragez pas, vous allez y arriver !
Dtaillons ce schma, tape par tape. Lancement de l'application : lorsque l'internaute accdera votre site, un fichier PHP est excut sur le serveur. Dans notre cas, ce fichier sera excut chaque fois que le visiteur voudra accder une page, quelle que soit cette dernire. Que le visiteur veuille afficher une news, ouvrir un forum ou poster un commentaire, c'est ce fichier qui sera excut (nous verrons comment plus tard). Ce fichier sera trs rduit : il ne fera que lancer l'application (nous verrons plus tard qu'il se contente d'instancier une classe et d'invoquer une mthode). Chargement de la requte du client : cette tape consiste analyser la requte envoye par le client. C'est lors de cette tape que l'application ira chercher les variables transmises par formulaire ou par URL (les fameuses variables GET et POST). Excution de la page dsire : c'est ici le cur de l'excution de l'application. Mais comment l'application connat-elle la page excuter ? Quelle action le visiteur veut-il excuter ? Veut-il afficher une news, visiter un forum, poster un commentaire ? Cette action est dtermine par ce qu'on appelle un routeur. En analysant l'URL, le routeur est capable de savoir ce que le visiteur veut. Par exemple, si l'URL entre par le visiteur est http://www.monsupersite.com/news-12.html , alors le routeur saura que le visiteur veut afficher la news ayant pour identifiant 12 dans la base de donnes. Le routeur
www.siteduzero.com
235/333
va donc retourner cette action l'application qui l'excutera (nous verrons plus tard ce dont il s'agit vraiment). Envoi de la rponse au client : aprs avoir excut l'action dsire (par exemple, si le visiteur veut afficher une news, l'action correspondante est de rcuprer cette news), l'application va afficher le tout, et l'excution du script sera termine. C'est ce moment-l que la page sera envoye au visiteur.
Pour bien cerner le principe, prenons un exemple. Si le visiteur veut voir la news n12, alors il demandera la page news-12.html . Schmatiquement, voici ce qui va se passer (voir la figure suivante).
www.siteduzero.com
236/333
Il est trs important de comprendre ce principe. Si vous ne saisissez pas tout, n'hsitez pas relire les explications, sinon vous risquez de ne pas suivre la suite du cours. V ous tes maintenant au courant qu'une application s'excute et qu'elle a pour rle d'orchestrer l'excution du script afin de donner la page au visiteur. Dans un tutoriel sur la POO en PHP, je suis sr que vous savez comment sera reprsent cette application dans votre script... Oui, notre application sera un objet ! Qui dit objet dit classe, et qui dit classe dit fonctionnalits. Reprenez le schma et noncez-moi les fonctionnalits que possde notre classe Application... Pour l'instant, elle ne possde qu'une fonctionnalit : celle de s'excuter (nous verrons par la suite qu'elle en possdera plusieurs autres, mais vous ne pouviez pas les deviner). Cette fonctionnalit est obligatoire quelle que soit l'application : quel serait l'intrt d'une application si elle ne pouvait pas s'excuter ? En gnral, dans un site web, il y a deux applications : le frontend et le backend . La premire est l'application accessible par tout le monde : c'est travers cette application qu'un visiteur pourra afficher une news, lire un sujet d'un forum, poster un commentaire, etc. La seconde application est l'espace d'administration : l'accs est bloqu aux visiteurs. Pour y accder, une paire identifiant-mot de passe est requise. Comme vous l'aurez peut-tre compris, ces deux applications seront reprsentes par deux classes hritant de notre classe de base Application.
Un peu d'organisation
Nous avons vu suffisamment de notions pour se pencher sur l'architecture de notre projet. En effet, nous savons que notre site web sera compos de deux applications (frontend et backend ) ainsi que d'une classe de base Application. La classe Application fait partie de notre bibliothque (ou library en anglais), comme de nombreuses autres classes dont nous parlerons plus tard. Toutes ces classes vont, par consquent, tre places dans un dossier /Library . Pour les deux applications, c'est un peu plus compliqu. En effet, une application ne tient pas dans un seul fichier : elle est divise en plusieurs parties. Parmi ces parties, nous trouvons la plus grosse : la partie contenant les modules. Qu'est-ce qu'un module ?
Un module est un ensemble d'actions et de donnes concernant une partie du site. Par exemple, les actions afficher une news et commenter une news font partie du mme module de news, tandis que les actions afficher ce sujet et poster dans ce sujet font partie du module du forum. Ainsi, je vous propose l'architecture suivante : Le dossier /Applications contiendra nos applications (frontend et backend ). Le sous-dossier /Applications/Nomdelapplication/Modules contiendra les modules de l'application (par exemple, si l'application frontend possde un module de news, alors il y aura un dossier /Applications/Frontend/Modules/News ). Ne vous inquitez pas, nous reviendrons en dtail sur ces fameux modules. J'ai introduit la notion ici pour parler de l'architecture (et surtout de ce qui va suivre). En effet, vous devriez vous posez une question : quand l'utilisateur veut afficher une page, quel fichier PHP sera excut en premier ? Ou pourrai-je placer mes feuilles de style et mes images ? Tous les fichiers accessibles au public devront tre placs dans un dossier /Web. Pour tre plus prcis, votre serveur HTTP ne pointera pas vers la racine du projet, mais vers le dossier /Web. Je m'explique. Sur votre serveur local, si vous tapez localhost dans la barre d'adresse, alors votre serveur renverra le contenu du dossier C:\Wamp\www si vous tes sous WampServer, ou du dossier /var/www si vous tes sous LAMP. V ous tes-vous dj demand comment est-ce que cela se faisait ? Qui a dcrt cela ? En fait, c'est crit quelque part, dans un fichier de configuration. Il y en a un qui dit que si on tape localhost dans la barre d'adresse, alors on se connectera sur l'ordinateur. Ce fichier de configuration est le fichier hosts . Le chemin menant ce fichier est C:\windows\system32\drivers\etc\hosts sous Windows et /etc/hosts sous Linux et Mac OS. V ous pouvez l'diter ( condition d'avoir les droits). Faites le test : ajoutez la ligne suivante la fin du fichier. Code : autre 127.0.0.1 monsupersite
www.siteduzero.com
237/333
Sauvegardez le fichier et fermez-le. Ouvrez votre navigateur, tapez monsupersite et... vous atterrissez sur la mme page que quand vous tapiez localhost ! Maintenant, nous allons utiliser un autre fichier. La manipulation va consister dire l'ordinateur que lorsqu'on tape monsupersite, on ne voudra pas le contenu de C:\Wamp\www ou de /var/www, mais de C:\Wamp\www\monsupersite\Web si vous tes sous Windows ou de /var/www/monsupersite/Web si vous tes sous Linux ou Mac OS. Tout d'abord, je vous annonce que nous allons utiliser le module mod_vhost_alias d'Apache. Assurez-vous donc qu'il soit bien activ. Le fichier que nous allons manipuler est le fichier de configuration d'Apache, savoir httpd.conf sous WampServer. Rajoutez la fin du fichier : Code : Apache <VirtualHost *:80> ServerAdmin webmaster@localhost # Mettez ici le nom de domaine que vous avez utilis dans le fichier hosts. ServerName monsupersite # Mettez ici le chemin vers lequel doit pointer le domaine. # Je suis sous Linux. Si vous tes sous Windows, le chemin sera de la forme C:\Wamp\www\monsupersite\Web DocumentRoot /home/victor/www/monsupersite/Web <Directory /home/victor/www/monsupersite/Web> Options Indexes FollowSymLinks MultiViews # Cette directive permet d'activer les .htaccess. AllowOverride All # Si le serveur est accessible via l'Internet mais que vous n'en faites qu'une utilisation personnelle # pensez interdire l'accs tout le monde # sauf au localhost, sinon vous ne pourrez pas y accder ! deny from all allow from localhost </Directory> </VirtualHost>
Si vous avez un serveur LAMP, n'essayez pas de trouver le fichier httpd.conf , il n'existe pas. En fait, la cration d'htes virtuels s'effectue en crant un nouveau fichier contenant la configuration de ce dernier. Le fichier crer est /etc/apache2/sites-available/monsupersite (remplacez monsupersite par le domaine choisi). Placez-y l'intrieur le contenu que je vous ai donn. Ensuite, il n'y a plus qu' activer cette nouvelle configuration grce la commande sudo a2ensite monsupersite (remplacez monsupersite par le nom du fichier contenant la configuration de l'hte virtuel). Dans tous les cas, que vous soyez sous Windows, Linux, Mac OS ou quoi que ce soit d'autre, redmarrez Apache pour que la nouvelle configuration soit prise en compte. Essayez d'entrer monsupersite dans la barre d'adresse, et vous verrez que le navigateur vous affiche le dossier spcifi dans la configuration d'Apache !
www.siteduzero.com
238/333
Le contrleur
Nous allons donc crer pour chaque module un contrleur qui contiendra au moins autant de mthodes que d'actions. Par exemple, si dans le module de news je veux pouvoir avoir la possibilit d'afficher l'index du module (qui nous dvoilera la liste des cinq dernires news par exemple) et afficher une news, j'aurais alors deux mthodes dans mon contrleur : executeIndex et executeShow. Ce fichier aura pour nom NomDuModuleController.class.php, ce qui nous donne, pour le module de news, un fichier du nom de NewsController.class.php. Celui-ci est directement situ dans le dossier du module.
Les vues
Chacune de ces actions correspond, comme vous le savez, une vue. Nous aurons donc pour chaque action une vue du mme nom. Par exemple, pour l'action show, nous aurons un fichier show.php. Toutes les vues sont placer dans le dossier Views du module.
Les modles
En fait, les modles, vous les connaissez dj : il s'agit des managers . Ce sont eux qui feront office de modles. Les modles ne sont rien d'autre que des fichiers permettant l'interaction avec les donnes. Pour chaque module, nous aurons donc au moins deux fichiers constituant le modle : le manager abstrait de base (NewsManager.class.php) et au moins une classe exploitant ce manager (par exemple NewsManager_PDO.class.php). Tous les modles devront tre placs dans le dossier /Library/Models afin qu'ils puissent tre utiliss facilement par deux applications diffrentes (ce qui est souvent le cas avec les applications backend et frontend ). Cependant, ces modles ont besoin des classes reprsentant les entits qu'ils grent. La classe reprsentant un enregistrement (comme News dans notre cas) sera, elle, place dans le dossier /Library/Entities . Nous aurons l'occasion de faire un petit rappel sur cette organisation lors du prochain chapitre.
www.siteduzero.com
239/333
Zoom sur le routeur V ous vous posez peut-tre des questions sur le contenu de la deuxime bulle associe au routeur. En fait, le routeur analyse toute l'URL et dcrypte ce qui s'y cache (nous verrons plus tard comment). Quand je dis que tout le monde pourra y accder travers la requte du client , c'est que nous pourrons accder cette valeur travers la classe qui reprsentera la requte du client (que nous construirons d'ailleurs durant le prochain chapitre).
La page
Nous avons parl jusqu' prsent du droulement de l'application et nous avons commenc creuser un petit peu en parlant de l'organisation interne avec l'utilisation du pattern MVC. Cependant, comment est gnre la page que le visiteur aura devant les yeux ? Cette page, vous l'aurez peut-tre devin, sera reprsente par une classe. Comme d'habitude, qui dit classe dit fonctionnalits. En effet, une page en possde plusieurs : Celle d'ajouter une variable la page (le contrleur aura besoin de passer des donnes la vue). Celle d'assigner une vue la page (il faut qu'on puisse dire notre page quelle vue elle doit utiliser). De gnrer la page avec le layout de l'application. Des explications s'imposent, notamment sur ce que sont prcisment ces vues et ce fameux layout . Le layout est le fichier contenant l'enveloppe du site (dclaration du doctype, inclusion des feuilles de style, dclaration des balises meta, etc.). V oici un exemple trs simple : Code : PHP <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr"> <head> <title>Mon super site</title> <meta http-equiv="Content-type" content="text/html; charset=iso8859-1" /> </head>
www.siteduzero.com
240/333
Le layout , spcifique chaque application, doit se placer dans /Applications/Nomdelapplication/Templates , sous le nom de layout.php. Comme vous pouvez vous en apercevoir, il y a une variable $content qui trane. V ous aurez sans doute devin que cette variable sera le contenu de la page : ce sera donc notre classe Page qui se chargera de gnrer la vue, de stocker ce contenu dans $content puis d'inclure le layout correspondant l'application. Schmatiquement, voici comment la page se construit (voir la figure suivante).
L'autoload
L'autoload sera trs simple. En effet, comme nous le verrons plus tard, chaque classe se situe dans un namespace. Ces namespaces correspondent aux dossiers dans lesquels sont places les classes. Si vous n'avez jamais entendu parler des namespaces, je vous invite lire le tutoriel Les espaces de noms en PHP.
Prenons l'exemple de la classe Application. Comme nous l'avons vu, cette classe fait partie de notre bibliothque, donc est place dans le dossier /Library , stock dans le fichier Application.class.php. Ce fichier, puisqu'il est plac dans le dossier /Library , contiendra donc la classe Application dans le namespace Library : Code : PHP - /Library/Application.class.php <?php namespace Library;
www.siteduzero.com
241/333
Maintenant, regardons du ct de l'autoload. Souvenez-vous : notre fonction, appele par PHP lorsqu'une classe non dclare est invoque, possde un paramtre, le nom de la classe. Cependant, si la classe si situe dans un namespace, alors il n'y aura pas que le nom de la classe qui sera pass en argument notre fonction, mais le nom de la classe prcd du namespace qui la contient. Si l'on prend l'exemple de notre classe Application, et que l'on l'instancie pour que l'autoload soit appel, alors l'argument vaudra Library\Application. V ous voyez quoi ressemblera notre autoload ? Il se contentera de remplacer les antislashes (\) par des slashes (/) de l'argument et d'inclure le fichier correspondant. Notre autoload, situ dans /Library , ressemblera donc a : Code : PHP - /Library/autoload.php <?php function autoload($class) { require '../'.str_replace('\\', '/', $class).'.class.php'; } spl_autoload_register('autoload');
Gardez-le dans un coin de votre ordinateur, vous le comprendrez sans doute mieux au fil de la cration de l'application.
www.siteduzero.com
242/333
Droulement dtaill de l'application Il est indispensable que vous compreniez ce schma. Si vous ne voulez pas l'apprendre par cur, imprimez-le afin de toujours l'avoir sous les yeux quand vous travaillerez sur ce projet !
www.siteduzero.com
243/333
Dveloppement de la bibliothque
Le plus gros a t fait : nous savons comment fonctionnera notre application, nous savons o nous voulons aller. Maintenant, il ne reste plus qu' nous servir de tout cela pour construire les diagrammes UML qui vont lier toutes nos classes, nous permettant ainsi de les crire plus facilement. Accrochez-vous vos claviers, a ne va pas tre de tout repos !
L'application L'application
Commenons par construire notre classe Application. Souvenez-vous : nous avions dit que cette classe possdait une fonctionnalit, celle de s'excuter. Or je ne vous ai pas encore parl des caractristiques de l'application. La premire ne vous vient peut-tre pas l'esprit, mais je l'ai pourtant dj voqu : il s'agit du nom de l'application. Il en existe deux autres. Nous en avons brivement parl, et il est fort probable que vous les ayez oublies : il s'agit de la requte ainsi que la rponse envoye au client. Ainsi, avant de crer notre classe Application, nous allons nous intresser ces deux entits.
La requte du client
Schmatisons
Comme vous vous en doutez, nous allons reprsenter la requte du client au travers d'une instance de classe. Comme pour toute classe, intressons-nous aux fonctionnalits attendues. Qu'est-ce qui nous intresse dans la requte du client ? Quelles fonctionnalits seraient intressantes ? partir de cette instance, il serait pratique de pouvoir : Obtenir une variable POST. Obtenir une variable GET. Obtenir un cookie. Obtenir la mthode employe pour envoyer la requte (mthode GET ou POST). Obtenir l'URL entre (utile pour que le routeur connaisse la page souhaite).
Et pour la route, voici un petit diagramme (j'en ai profit pour ajouter des mthodes permettant de vrifier l'existence de tel cookie / variable GET / variable POST) - voir la figure suivante.
Codons
Le contenu est assez simple, les mthodes effectuent des oprations basiques. V oici donc le rsultat auquel vous tiez cens arriver : Code : PHP <?php namespace Library; class HTTPRequest {
www.siteduzero.com
244/333
Un petit mot sur la toute premire ligne, celle qui contient la dclaration du namespace. J'en avais dj parl lors de l'criture de l'autoload, mais je me permets de faire une petite piqre de rappel. Toutes les classes de notre projet sont dclares dans des namespaces. Cela permet d'une part de structurer son projet et, d'autre part, d'crire un autoload simple qui sait directement, grce au namespace contenant la classe, le chemin du fichier contenant ladite classe. Par exemple, si j'ai un contrleur du module news. Celui-ci sera plac dans le dossier /Applications/Frontend/Modules/News (si vous avez oubli ce chemin, ne vous inquitez pas, nous y reviendrons : je l'utilise juste pour l'exemple). La classe reprsentant ce contrleur (NewsController) sera donc dans le namespace Applications\Frontend\Modules\News !
www.siteduzero.com
245/333
Notez la valeur par dfaut du dernier paramtre de la mthode setCookie() : elle est true, alors qu'elle est false sur la fonction setcookie() de la librairie standard de PHP. Il s'agit d'une scurit qu'il est toujours prfrable d'activer. Concernant la redirection vers la page 404, laissez-l vide pour l'instant, nous nous chargerons de son implmentation par la suite.
Codons
V oici le code que vous devriez avoir obtenu : Code : PHP <?php namespace Library; class HTTPResponse { protected $page; public function addHeader($header) { header($header); } public function redirect($location) { header('Location: '.$location); exit; } public function redirect404() { } public function send() { // Actuellement, cette ligne a peu de sens dans votre esprit. // Promis, vous saurez vraiment ce qu'elle fait d'ici la fin du chapitre // (bien que je suis sr que les noms choisis sont assez explicites !). exit($this->page->getGeneratedPage());
www.siteduzero.com
246/333
Codons
Le code est trs basique. Le constructeur se charge uniquement d'instancier les classes HTTPRequest et HTTPResponse. Quant aux autres mthodes, ce sont des accesseurs, nous avons donc vite fait le tour. Code : PHP <?php namespace Library; abstract class Application { protected $httpRequest; protected $httpResponse; protected $name; public function __construct() { $this->httpRequest = new HTTPRequest; $this->httpResponse = new HTTPResponse; $this->name = '';
www.siteduzero.com
247/333
Dans le constructeur, vous voyez qu'on assigne une valeur nulle l'attribut name. En fait, chaque application (qui hritera donc de cette classe) sera charge de spcifier son nom en initialisant cet attribut (par exemple, l'application frontend assignera la valeur Frontend cet attribut).
D'obtenir l'application laquelle l'objet appartient. C'est tout ! Cette classe se chargera juste de stocker, pendant la construction de l'objet, l'instance de l'application excute. Nous avons donc une simple classe ressemblant celle-ci (voir la figure suivante).
Niveau code, je pense qu'on peut difficilement faire plus simple : Code : PHP <?php namespace Library; abstract class ApplicationComponent { protected $app; public function __construct(Application $app) { $this->app = $app; } public function app()
www.siteduzero.com
248/333
Pensez donc ajouter le lien de parent aux classes HTTPRequest et HTTPResponse. Et n'oubliez donc pas de passer l'instance de l'application lors de l'instanciation de ces deux classes dans le constructeur de Application.
La question que l'on se pose alors est : o seront crites les routes ? Certains d'entre vous seraient tents de les crire directement l'intrieur de la classe et faire une sorte de switch / case sur les routes pour trouver laquelle correspond l'URL. Cette faon de faire prsente un norme inconvnient : votre classe reprsentant le routeur sera dpendante du projet que vous dveloppez. Par consquent, vous ne pourrez plus l'utiliser sur un autre site ! Il va donc falloir externaliser ces dfinitions de routes. Comment pourrions-nous faire alors ? Puisque je vous ai dit que nous n'allons pas toucher la classe pour chaque nouvelle route ajouter, nous allons placer ces routes dans un autre fichier. Ce fichier doit tre plac dans le dossier de l'application, et puisque a touche la configuration de celle-ci, nous le placerons dans un sous-dossier Config. Il y a aussi un dtail rgler : dans quel format allons-nous crire le fichier ? Je vous propose le format XML car ce langage est intuitif et simple parser, notamment grce la bibliothque native DOMDocument de PHP. Si ce format ne vous plat pas, vous tes libre d'en choisir un autre, cela n'a pas d'importance, le but tant que vous ayez un fichier que vous arrivez parser. Le chemin complet vers ce fichier devient donc /Applications/Nomdelapplication/Config/routes.xml . Comme pour tout fichier XML qui se respecte, celui-ci doit suivre une structure prcise. Essayez de deviner la fonctionnalit de la ligne 3 : Code : XML <?xml version="1.0" encoding="iso-8859-1" ?> <routes> <route url="/news.html" module="News" action="index" /> </routes>
Alors, avez-vous une ide du rle de la troisime ligne ? Lorsque nous allons aller sur la page news.html , le routeur dira donc l'application : le client veut accder au module News et excuter l'action index . Un autre problme se pose. Par exemple, si je veux afficher une news spcifique en fonction de son identifiant, comment faire ? Ou, plus gnralement, comment passer des variables GET ? L'idal serait d'utiliser des expressions rgulires (ou regex) en guise d'URL. Chaque paire de parenthses reprsentera une variable GET. Nous spcifierons leur nom dans un quatrime attribut vars. Comme un exemple vaut mieux qu'un long discours, voyons donc un cas concret : Code : XML <route url="/news-(.+)-([0-9]+)\.html" module="News" action="show" vars="slug,id" />
www.siteduzero.com
249/333
Puisqu'il s'agit d'une expression rgulire et qu'elle sera vrifie par preg_match(), il est important d'chapper le point prcdent html . En effet, dans une expression rgulire, un point signifie tout caractre . Il faut donc l'chapper pour qu'il perde cette fonctionnalit.
On sait dsormais que notre routeur a besoin de routes pour nous renvoyer celle qui correspond l'URL. Cependant, s'il a besoin de routes, il va falloir les lui donner ! Pourquoi ne peut-il pas aller chercher lui-mme les routes ?
S'il allait les chercher lui-mme, notre classe serait dpendante de l'architecture de l'application. Si vous voulez utiliser votre classe dans un projet compltement diffrent, vous ne pourrez pas, car le fichier contenant les routes (/Applications/Nomdelapplication/Config/routes.xml ) n'existera tout simplement pas. De plus, dans ce projet, les routes ne seront peut-tre pas stockes dans un fichier XML, donc le parsage ne se fera pas de la mme faon. Or, je vous l'avais dj dit dans les premiers chapitres, mais l'un des points forts de la POO est son caractre rutilisable. Ainsi, votre classe reprsentant le routeur ne dpendra ni d'une architecture, ni du format du fichier stockant les routes. De cette faon, notre classe prsente dj deux fonctionnalits : Celle d'ajouter une route. Celle de renvoyer la route correspondant l'URL. Avec, bien entendu, une caractristique : la liste des routes attache au routeur. Cependant, une autre question se pose : nous disons qu'on passe une route au routeur. Mais comment est matrialise une route ? Puisque vous pensez orient objet, vous devriez automatiquement me dire une route, c'est un objet ! . Intressons-nous donc maintenant notre objet reprsentant une route. Cet objet, qu'est-ce qui le caractrise ? Une URL. Un module. Une action. Un tableau comportant les noms des variables. Un tableau cl/valeur comportant les noms/valeurs des variables. Quelle diffrence entre les deux dernires caractristiques ?
En fait, lorsque nous crerons les routes, nous allons assigner les quatre premires caractristiques (souvenez-vous du fichier XML : nous dfinissons une URL, un module, une action, et la liste des noms des variables). C'est donc cette dernire liste de variables que nous allons assigner notre route. Ensuite, notre routeur ira parcourir ces routes et c'est lui qui assignera les valeurs des variables. C'est donc ce moment-l que le tableau comportant les noms/valeurs des variables sera cr et assign l'attribut correspondant. Nous pouvons maintenant dresser la liste des fonctionnalits de notre objet reprsentant une route : Celle de savoir si la route correspond l'URL. Celle de savoir si la route possde des variables (utile, nous le verrons, dans notre routeur).
Pour rsumer, voici le diagramme UML reprsentant nos classes (voir la figure suivante).
www.siteduzero.com
250/333
Codons
Commenons par nos deux classes Router et Route : Code : PHP - /Library/Router.class.php <?php namespace Library; class Router { protected $routes = array(); const NO_ROUTE = 1; public function addRoute(Route $route) { if (!in_array($route, $this->routes)) { $this->routes[] = $route; } } public function getRoute($url) { foreach ($this->routes as $route) { // Si la route correspond l'URL. if (($varsValues = $route->match($url)) !== false) {
www.siteduzero.com
251/333
} }
return $route;
Code : PHP - /Library/Route.class.php <?php namespace Library; class Route { protected protected protected protected protected
public function __construct($url, $module, $action, array $varsNames) { $this->setUrl($url); $this->setModule($module); $this->setAction($action); $this->setVarsNames($varsNames); } public function hasVars() { return !empty($this->varsNames); } public function match($url) { if (preg_match('`^'.$this->url.'$`', $url, $matches)) { return $matches; } else { return false; }
www.siteduzero.com
252/333
Tout cela est bien beau, mais il serait tout de mme intressant d'exploiter notre routeur afin de l'intgrer dans notre application. Pour cela, nous allons implmenter une mthode dans notre classe Application qui sera charge de nous donner le contrleur correspondant l'URL. Pour cela, cette mthode va parcourir le fichier XML pour ajouter les routes au routeur. Ensuite, elle va rcuprer la route correspondante l'URL (si une exception a t leve, on lvera une erreur 404). Enfin, la mthode instanciera le contrleur correspondant la route et le renverra (il est possible que vous ne sachiez pas comment faire car nous n'avons pas encore vu le contrleur en dtail, donc laissez a de ct et regardez la correction, vous comprendrez plus tard). V oici notre nouvelle classe Application :
www.siteduzero.com
253/333
public function getController() { $router = new \Library\Router; $xml = new \DOMDocument; $xml->load(__DIR__.'/../Applications/'.$this>name.'/Config/routes.xml'); $routes = $xml->getElementsByTagName('route'); // On parcourt les routes du fichier XML. foreach ($routes as $route) { $vars = array(); // On regarde si des variables sont prsentes dans l'URL. if ($route->hasAttribute('vars')) { $vars = explode(',', $route->getAttribute('vars')); } // On ajoute la route au routeur. $router->addRoute(new Route($route->getAttribute('url'), $route->getAttribute('module'), $route->getAttribute('action'), $vars)); } try { // On rcupre la route correspondante l'URL. $matchedRoute = $router->getRoute($this->httpRequest>requestURI()); } catch (\RuntimeException $e) { if ($e->getCode() == \Library\Router::NO_ROUTE) { // Si aucune route ne correspond, c'est que la page demande n'existe pas. $this->httpResponse->redirect404(); } } // On ajoute les variables de l'URL au tableau $_GET. $_GET = array_merge($_GET, $matchedRoute->vars()); // On instancie le contrleur. $controllerClass = 'Applications\\'.$this>name.'\\Modules\\'.$matchedRoute->module().'\\'.$matchedRoute>module().'Controller';
www.siteduzero.com
254/333
Le back controller
Nous venons de construire notre routeur qui donne l'application le contrleur associ. Afin de suivre la logique du droulement de l'application, construisons maintenant notre back controller de base.
Rflchissons, schmatisons
Remmorons-nous ce que permet de faire un objet BackController. Nous avions vu qu'un tel objet n'offrait qu'une seule fonctionnalit : celle d'excuter une action. Comme pour l'objet Application, je ne vous avais pas parl des caractristiques d'un back controller. Qu'est-ce qui caractrise un back controller ? Si vous connaissez l'architecture MVC, vous savez qu'une vue est associe au back controller : c'est donc l'une de ses caractristiques. Maintenant, pensons la nature d'un back controller. Celui-ci est propre un module, et si on l'a instanci c'est que nous voulons qu'il excute une action. Cela fait donc deux autres caractristiques : le module et l'action. Enfin, il y en a une dernire que vous ne pouvez pas deviner : la page associe au contrleur. Comme nous le verrons bientt, c'est travers cette instance reprsentant la page que nous allons envoyer au visiteur que le contrleur transmettra des donnes la vue. Pour l'instant, mmorisez juste l'ide que le contrleur est associ une page stocke en tant qu'instance dans un attribut de la classe BackController. Une instance de BackController nous permettra donc : D'excuter une action (donc une mthode). D'obtenir la page associe au contrleur. De modifier le module, l'action et la vue associs au contrleur.
Cette classe est une classe de base dont hritera chaque contrleur. Par consquent, elle se doit d'tre abstraite. Aussi, il s'agit d'un composant de l'application, donc un lien de parent avec ApplicationComponent est crer. Nous arrivons donc une classe ressemblant a (voir la figure suivante).
www.siteduzero.com
255/333
Notre constructeur se chargera dans un premier temps d'appeler le constructeur de son parent. Dans un second temps, il crera une instance de la classe Page qu'il stockera dans l'attribut correspondant. Enfin, il assignera les valeurs au module, l'action et la vue (par dfaut la vue a la mme valeur que l'action). Concernant la mthode execute(), comment fonctionnera-t-elle ? Son rle est d'invoquer la mthode correspondant l'action assigne notre objet. Le nom de la mthode suit une logique qui est de se nommer executeNomdelaction(). Par exemple, si nous avons une action show sur notre module, nous devrons implmenter la mthode executeShow() dans notre contrleur. Aussi, pour une question de simplicit, nous passerons la requte du client la mthode. En effet, dans la plupart des cas, les mthodes auront besoin de la requte du client pour obtenir une donne (que ce soit une variable GET, POST, ou un cookie).
Codons
V oici le rsultat qui tait obtenir : Code : PHP <?php namespace Library; abstract class BackController extends ApplicationComponent { protected $action = ''; protected $module = ''; protected $page = null; protected $view = ''; public function __construct(Application $app, $module, $action) { parent::__construct($app); $this->page = new Page($app); $this->setModule($module); $this->setAction($action); $this->setView($action);
www.siteduzero.com
256/333
public function page() { return $this->page; } public function setModule($module) { if (!is_string($module) || empty($module)) { throw new \InvalidArgumentException('Le module doit tre une chaine de caractres valide'); } } $this->module = $module;
public function setAction($action) { if (!is_string($action) || empty($action)) { throw new \InvalidArgumentException('L\'action doit tre une chaine de caractres valide'); } } $this->action = $action;
public function setView($view) { if (!is_string($view) || empty($view)) { throw new \InvalidArgumentException('La vue doit tre une chaine de caractres valide'); } } $this->view = $view;
www.siteduzero.com
257/333
En plus du DAO, il faudra donc spcifier notre classe grant ces managers l'API que l'on souhaite utiliser. Suivant ce qu'on lui demande, notre classe nous retournera une instance de NewsManager_PDO ou NewsManager_MySQLi par exemple.
La classe Managers
Schmatiquement, voici quoi ressemble la classe Managers (voir la figure suivante).
Cette instance de Managers sera stocke dans un attribut de l'objet BackController comme $managers par exemple. L'attribution d'une instance de Managers cet attribut se fait dans le constructeur de la manire suivante : Code : PHP <?php namespace Library; abstract class BackController extends ApplicationComponent { // ... protected $managers = null; public function __construct(Application $app, $module, $action) { parent::__construct($app); $this->managers = new Managers('PDO', PDOFactory::getMysqlConnexion()); $this->page = new Page($app); $this->setModule($module); $this->setAction($action); $this->setView($action);
} }
// ...
Niveau code, voici quoi ressemble la classe Managers : Code : PHP <?php namespace Library; class Managers { protected $api = null; protected $dao = null; protected $managers = array(); public function __construct($api, $dao) { $this->api = $api; $this->dao = $dao;
www.siteduzero.com
258/333
Non car cela vous obligerait modifier la classe BackController chaque modification, ce qui n'est pas trs flexible. Je vous conseille plutt d'utiliser le pattern factory que nous avons vu durant la prcdente partie avec la classe PDOFactory : Code : PHP <?php namespace Library; class PDOFactory { public static function getMysqlConnexion() { $db = new \PDO('mysql:host=localhost;dbname=news', 'root', ''); $db->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION); } return $db;
www.siteduzero.com
259/333
Par contre, la classe Entity est lgrement plus complexe. En effet, celle-ci offre quelques fonctionnalits : Implmentation d'un constructeur qui hydratera l'objet si un tableau de valeurs lui est fourni. Implmentation d'une mthode qui permet de vrifier si l'enregistrement est nouveau ou pas. Pour cela, on vrifie si l'attribut $id est vide ou non (ce qui inclut le fait que toutes les tables devront possder un champ nomm id). Implmentation des getters / setters. Implmentation de l'interface ArrayAccess (ce n'est pas obligatoire, c'est juste que je prfre utiliser l'objet comme un tableau dans les vues). Le code obtenu devrait s'apparenter celui-ci : Code : PHP <?php namespace Library; abstract class Entity implements \ArrayAccess { protected $erreurs = array(), $id; public function __construct(array $donnees = array()) { if (!empty($donnees)) { $this->hydrate($donnees); } } public function isNew() { return empty($this->id); } public function erreurs() { return $this->erreurs; } public function id() { return $this->id; } public function setId($id) { $this->id = (int) $id; } public function hydrate(array $donnees) { foreach ($donnees as $attribut => $valeur) { $methode = 'set'.ucfirst($attribut); if (is_callable(array($this, $methode))) { $this->$methode($valeur); }
www.siteduzero.com
260/333
public function offsetExists($var) { return isset($this->$var) && is_callable(array($this, $var)); } public function offsetUnset($var) { throw new \Exception('Impossible de supprimer une quelconque valeur'); } }
La page
Toujours dans la continuit du droulement de l'application, nous allons nous intresser maintenant la page qui, nous venons de le voir, tait attache notre contrleur.
Rflchissons, schmatisons
Commenons par nous intresser aux fonctionnalits de notre classe Page. V ous le savez, une page est compose de la vue et du layout afin de gnrer le tout. Ainsi, nous avons une premire fonctionnalit : celle de gnrer une page. De plus, le contrleur doit pouvoir transmettre des variables la vue, stocke dans cette page : ajouter une variable la page est donc une autre fonctionnalit. Enfin, la page doit savoir quelle vue elle doit gnrer et ajouter au layout : il est donc possible d'assigner une vue la page (voir la figure suivante).
www.siteduzero.com
261/333
Composition d'une page Pour rsumer, une instance de notre classe Page nous permet : D'ajouter une variable la page (le contrleur aura besoin de passer des donnes la vue). D'assigner une vue la page. De gnrer la page avec le layout de l'application.
Avant de commencer coder cette classe, voici le diagramme la reprsentant (voir la figure suivante).
Codons
La classe est, me semble-t-il, plutt facile crire. Cependant, il se peut que vous vous demandiez comment crire la mthode getGeneratedPage(). En fait, il faut inclure les pages pour gnrer leur contenu, et stocker ce contenu dans une variable
www.siteduzero.com
262/333
grce aux fonctions de tamporisation de sortie pour pouvoir s'en servir plus tard. Pour la transformation du tableau stock dans l'attribut $vars en variables, regardez du ct de la fonction extract. Code : PHP <?php namespace Library; class Page extends ApplicationComponent { protected $contentFile; protected $vars = array(); public function addVar($var, $value) { if (!is_string($var) || is_numeric($var) || empty($var)) { throw new \InvalidArgumentException('Le nom de la variable doit tre une chaine de caractre non nulle'); } } $this->vars[$var] = $value;
public function getGeneratedPage() { if (!file_exists($this->contentFile)) { throw new \RuntimeException('La vue spcifie n\'existe pas'); } extract($this->vars); ob_start(); require $this->contentFile; $content = ob_get_clean(); ob_start(); require __DIR__.'/../Applications/'.$this->app>name().'/Templates/layout.php'; return ob_get_clean(); } public function setContentFile($contentFile) { if (!is_string($contentFile) || empty($contentFile)) { throw new \InvalidArgumentException('La vue spcifie est invalide'); } } $this->contentFile = $contentFile;
www.siteduzero.com
263/333
Et voici ce que l'on obtient : Code : PHP <?php namespace Library; class HTTPResponse extends ApplicationComponent { // ... public function redirect404() { $this->page = new Page($this->app); $this->page->setContentFile(__DIR__.'/../Errors/404.html'); $this->addHeader('HTTP/1.0 404 Not Found'); } } $this->send();
// ...
Bonus : l'utilisateur
Cette classe est un bonus , c'est--dire qu'elle n'est pas indispensable l'application. Cependant, nous allons nous en servir plus tard donc ne sautez pas cette partie ! Mais rassurez-vous, nous aurons vite fait de la crer.
www.siteduzero.com
264/333
Rflchissons, schmatisons
L'utilisateur, qu'est-ce que c'est ? L'utilisateur est celui qui visite votre site. Comme tout site web qui se respecte, nous avons besoin d'enregistrer temporairement l'utilisateur dans la mmoire du serveur afin de stocker des informations le concernant. Nous crons donc une session pour l'utilisateur. V ous connaissez sans doute ce systme de sessions avec le tableau $_SESSION et les fonctions ce sujet que propose l'API. Notre classe, que nous nommerons User, devra nous permettre de grer facilement la session de l'utilisateur. Nous pourrons donc, par le biais d'un objet User : Assigner un attribut l'utilisateur. Obtenir la valeur d'un attribut. Authentifier l'utilisateur (cela nous sera utile lorsque nous ferons un formulaire de connexion pour l'espace d'administration). Savoir si l'utilisateur est authentifi. Assigner un message informatif l'utilisateur que l'on affichera sur la page. Savoir si l'utilisateur a un tel message. Et enfin, rcuprer ce message.
Codons
Avant de commencer coder la classe, il faut que vous ajoutiez l'instruction invoquant session_start() au dbut du fichier, en dehors de la classe. Ainsi, ds l'inclusion du fichier par l'autoload, la session dmarrera et l'objet cr sera fonctionnel. Ceci tant, voici le code que je vous propose : Code : PHP <?php namespace Library; session_start(); class User extends ApplicationComponent { public function getAttribute($attr) { return isset($_SESSION[$attr]) ? $_SESSION[$attr] : null; } public function getFlash()
www.siteduzero.com
265/333
public function hasFlash() { return isset($_SESSION['flash']); } public function isAuthenticated() { return isset($_SESSION['auth']) && $_SESSION['auth'] === true; } public function setAttribute($attr, $value) { $_SESSION[$attr] = $value; } public function setAuthenticated($authenticated = true) { if (!is_bool($authenticated)) { throw new \InvalidArgumentException('La valeur spcifie la mthode User::setAuthenticated() doit tre un boolean'); } } $_SESSION['auth'] = $authenticated;
Comme promis, ce fut court, et tout ce qui compose cette classe est, il me semble, facilement comprhensible. Pensez modifier votre classe Application afin d'ajouter un attribut $user et crer l'objet User dans le constructeur que vous stockerez dans l'attribut cr.
Bonus 2 : la configuration
Cette classe est galement un bonus dans la mesure o elle n'est pas essentielle pour que l'application fonctionne. Je vous encourage vous entraner crer cette classe : tout comme la classe User, celle-ci n'est pas complique (si tant est que vous sachiez parser du XML avec une bibliothque telle que DOMDocument).
Rflchissons, schmatisons
Tout site web bien conu se doit d'tre configurable souhait. Par consquent, il faut que chaque application possde un fichier de configuration dclarant des paramtres propres ladite application. Par exemple, si nous voulons afficher un nombre de news prcis sur l'accueil, il serait prfrable de spcifier un paramtre nombre_de_news l'application que nous mettrons par exemple cinq plutt que d'insrer ce nombre en dur dans le code. De cette faon, nous aurons modifier uniquement ce nombre dans le fichier de configuration pour faire varier le nombre de news sur la page d'accueil.
www.siteduzero.com
266/333
Chaque paramtre se dclarera avec une balise define comme ceci : Code : XML <define var="nombre_news" value="5" />
Emplacement du fichier
Le fichier de configuration est propre chaque application. Par consquent, il devra tre plac aux cts du fichier routes.xml sous le doux nom de app.xml . Son chemin complet sera donc /Applications/Nomdelapplication/Config/app.xml .
Fonctionnement de la classe
Nous aurons donc une classe s'occupant de grer la configuration. Pour faire simple, nous n'allons lui implmenter qu'une seule fonctionnalit : celle de rcuprer un paramtre. Il faut galement garder l'esprit qu'il s'agit d'un composant de l'application, donc il faut un lien de parent avec... Je suis sr que vous savez ! La mthode get($var) (qui sera charge de rcuprer la valeur d'un paramtre) ne devra pas parcourir chaque fois le fichier de configuration, cela serait bien trop lourd. S'il s'agit du premier appel de la mthode, il faudra ouvrir le fichier XML en instanciant la classe DOMDocument et stocker tous les paramtres dans un attribut (admettons $vars). Ainsi, chaque fois que la mthode get() sera invoque, nous n'aurons qu' retourner le paramtre prcdemment enregistr. Notre classe, plutt simple, ressemble donc ceci (voir la figure suivante).
Codons
V oici le rsultat qui vous deviez obtenir : Code : PHP <?php namespace Library; class Config extends ApplicationComponent { protected $vars = array(); public function get($var) { if (!$this->vars)
www.siteduzero.com
267/333
Il faut, comme nous l'avons fait en crant la classe User, ajouter un nouvel attribut notre classe Application qui stockera l'instance de Config. Appelez-le par exemple $config (pour tre original ).
Notre bibliothque est crite, voil une bonne chose de faite ! Il ne reste plus qu' crire les applications et dvelopper les modules. Cependant, avant de continuer, je vais m'assurer que vous me suiviez toujours. V oici l'arborescence de l'architecture, avec des explications sur chaque dossier (voir la figure suivante).
Il est possible que des dossiers vous paraissent sortir de nulle part. Cependant, je vous assure que j'en ai parl au moins une fois lors de la cration de certaines classes. N'hsitez surtout pas relire le chapitre en vous appuyant sur cette arborescence, vous comprendrez sans doute mieux. Notre bibliothque est crite, voil une bonne chose de faite ! Il ne reste plus qu' crire les applications et dvelopper les modules. Cependant, avant de continuer, je vais m'assurer que vous me suiviez toujours. V oici l'arborescence de l'architecture, avec des explications sur chaque dossier :
www.siteduzero.com
268/333
Il est possible que des dossiers vous paraissent sortir de nulle part. Cependant, je vous assure que j'en ai parl au moins une fois lors de la cration de certaines classes. N'hsitez surtout pas relire le chapitre en vous appuyant sur cette arborescence, vous comprendrez sans doute mieux.
www.siteduzero.com
269/333
Le frontend
Nous allons enfin aborder quelque chose de concret en construisant notre premire application : le frontend . Cette application est la partie visible par tout le monde. Nous allons construire un module de news avec commentaires, il y a de quoi faire, donc ne perdons pas une seconde de plus ! Il est indispensable de connatre la classe DateTime. Cependant, ne vous inquitez pas, cette classe est trs simple d'utilisation, surtout que nous n'utiliserons que deux mthodes (le constructeur et la mthode format()).
L'application
Nous allons commencer par crer les fichiers de base dont nous aurons besoin. V ous en connaissez quelques uns dj : la classe reprsentant l'application, le layout, et les deux fichiers de configuration. Cependant, il nous en faut deux autres : un fichier qui instanciera notre classe et qui invoquera la mthode run(), et un .htaccess qui redirigera toutes les pages sur ce fichier. Nous verrons cela aprs avoir cr les quatre fichiers prcdemment cits.
La classe FrontendApplication
Commenons par crer notre classe FrontendApplication. Avant de commencer, assurez-vous que vous avez bien cr le dossier /Applications/Frontend qui contiendra notre application. Crez l'intrieur le fichier contenant notre classe, savoir FrontendApplication.class.php. Bien. Commencez par crire le minimum de la classe avec le namespace correspondant (je le rappelle : le namespace est identique au chemin venant vers le fichier contenant la classe) en implmentant les deux mthodes crire, savoir __construct() (qui aura pour simple contenu d'appeler le constructeur parent puis de spcifier le nom de l'application), et run(). Cette dernire mthode crira cette suite d'instruction : Obtention du contrleur grce la mthode parente getController(). Excution du contrleur. Assignation de la page cre par le contrleur la rponse. Envoi de la rponse.
V otre classe devrait ressembler ceci : Code : PHP - /Applications/Frontend/FrontendApplication.class.php <?php namespace Applications\Frontend; class FrontendApplication extends \Library\Application { public function __construct() { parent::__construct(); } $this->name = 'Frontend';
Le layout
www.siteduzero.com
270/333
Tout site web qui se respecte se doit d'avoir un design. Nous n'allons pas nous taler sur ce type de cration, ce n'est pas le sujet qui nous occupe. Nous allons donc nous servir d'un pack libre anciennement disponible sur un site de designs : j'ai nomm envision. C'est un design trs simple et facilement intgrable, idal pour ce que nous avons faire. Je vous laisse tlcharger le pack et dcouvrir les fichiers qu'il contient. Pour rappel, les fichiers sont placer dans /Web. V ous devriez ainsi vous retrouver avec deux dossiers dans /Web : /Web/css et /Web/images . Revenons-en au layout. Celui-ci est assez simple et respecte les contraintes imposes par le design. Code : PHP - /Applications/Frontend/Templates/layout.php <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr"> <head> <title> <?php if (!isset($title)) { ?> Mon super site <?php } else { echo $title; } ?> </title> <meta http-equiv="Content-type" content="text/html; charset=iso8859-1" /> /> <link rel="stylesheet" href="/css/Envision.css" type="text/css" </head> <body> <div id="wrap"> <div id="header"> <h1 id="logo-text"><a href="/">Mon super site</a></h1> <p id="slogan">Comment a il n'y a presque rien ?</p> </div> <div id="menu"> <ul> <li><a href="/">Accueil</a></li> <?php if ($user->isAuthenticated()) { ?> <li><a href="/admin/">Admin</a></li> <li><a href="/admin/news-insert.html">Ajouter une news</a></li> <?php } ?> </ul> </div> <div id="content-wrap"> <div id="main"> <?php if ($user->hasFlash()) echo '<p style="text-align: center;">', $user->getFlash(), '</p>'; ?> <?php echo $content; ?> </div> </div> <div id="footer"></div> </div> </body> </html>
www.siteduzero.com
271/333
La variable $user fait rfrence l'instance de User. Elle doit tre initialise dans la mthode getGeneratedPage() de la classe Page : Code : PHP - Extrait de /Library/Page.class.php <?php namespace Library; class Page extends ApplicationComponent { // ... public function getGeneratedPage() { if (!file_exists($this->contentFile)) { throw new \InvalidArgumentException('La vue spcifie n\'existe pas'); } $user = $this->app->user(); extract($this->vars); ob_start(); require $this->contentFile; $content = ob_get_clean(); ob_start(); require dirname(__FILE__).'/../Applications/'.$this->app>name().'/Templates/layout.php'; return ob_get_clean(); } } // ...
Notez que si vous utilisez la variable $this, elle fera rfrence l'objet Page car le layout est inclut dans la mthode Page::getGeneratedPage().
www.siteduzero.com
272/333
L'instanciation de FrontendApplication
Pour instancier FrontendApplication, il va falloir crer un fichier frontend.php. Ce fichier devra d'abord inclure l'autoload. Celui-ci aura donc pour simple contenu : Code : PHP - /Web/frontend.php <?php require '../Library/autoload.php'; $app = new Applications\Frontend\FrontendApplication; $app->run();
Le module de news
Nous allons commencer en douceur par un systme de news. Pourquoi en douceur ? Car vous avez dj fait cet exercice lors du prcdent TP ! Ainsi, nous allons voir comment l'intgrer au sein de l'application, et vous verrez ainsi plus clair sur la manire dont elle fonctionne. Pour ne perdre personne, nous allons refaire le TP petit petit pour mieux l'intgrer dans l'application. Ainsi, je vais commencer par vous rappeler ce que j'attends du systme de news.
Fonctionnalits
Il doit tre possible d'excuter deux actions diffrentes sur le module de news : Afficher l'index du module. Cela aura pour effet de dvoiler les cinq dernires news avec le titre et l'extrait du contenu (seuls les 200 premiers caractres seront affichs). Afficher une news spcifique en cliquant sur son titre. L'auteur apparatra, ainsi que la date de modification si la news a t modifie. Comme pour tout module, commencez par crer les dossiers et fichiers de base, savoir : Le dossier /Applications/Frontend/Modules/News qui contiendra notre module. Le fichier /Applications/Frontend/Modules/News/NewsController.class.php qui contiendra notre contrleur. Le dossier /Applications/Frontend/Modules/News/Views qui contiendra les vues. Le fichier /Library/Models/NewsManager.class.php qui contiendra notre manager de base; Le fichier /Library/Models/NewsManager_PDO.class.php qui contiendra notre manager utilisant PDO. Le fichier /Library/Entities/News.class.php qui contiendra la classe reprsentant un enregistrement.
www.siteduzero.com
273/333
Nous pouvons dsormais crire la classe reprsentant cette entit : News. Code : PHP - /Library/Entities/News.class.php <?php namespace Library\Entities; class News extends \Library\Entity { protected $auteur, $titre, $contenu, $dateAjout, $dateModif; const AUTEUR_INVALIDE = 1; const TITRE_INVALIDE = 2; const CONTENU_INVALIDE = 3; public function isValid() { return !(empty($this->auteur) || empty($this->titre) || empty($this->contenu)); } // SETTERS // public function setAuteur($auteur) { if (!is_string($auteur) || empty($auteur)) { $this->erreurs[] = self::AUTEUR_INVALIDE; } else { $this->auteur = $auteur; } } public function setTitre($titre) { if (!is_string($titre) || empty($titre)) { $this->erreurs[] = self::TITRE_INVALIDE; } else { $this->titre = $titre; } } public function setContenu($contenu) { if (!is_string($contenu) || empty($contenu)) {
www.siteduzero.com
274/333
public function setDateAjout(\DateTime $dateAjout) { $this->dateAjout = $dateAjout; } public function setDateModif(\DateTime $dateModif) { $this->dateModif = $dateModif; } // GETTERS // public function auteur() { return $this->auteur; } public function titre() { return $this->titre; } public function contenu() { return $this->contenu; } public function dateAjout() { return $this->dateAjout; } public function dateModif() { return $this->dateModif; }
L'action index
La route
Commenons par implmenter cette action. La premire chose faire est de crer une nouvelle route : quelle URL pointera vers cette action ? Je vous propose simplement que ce soit la racine du site web, donc ce sera l'URL / . Pour crer cette route, il va falloir modifier notre fichier de configuration et y ajouter cette ligne : Code : XML - Extrait de /Applications/Frontend/Config/routes.xml <route url="/" module="News" action="index" />
Le contrleur
www.siteduzero.com
275/333
Qui dit nouvelle action dit nouvelle mthode, et cette mthode c'est executeIndex(). Cette mthode devra rcuprer les cinq dernires news (le nombre cinq devra tre stock dans le fichier de configuration de l'application, savoir /Applications/Frontend/Config/app.xml ). Il faudra parcourir cette liste de news afin de n'assigner aux news qu'un contenu de 200 caractres au maximum. Ensuite, il faut passer la liste des news la vue : Code : PHP - /Applications/Frontend/Modules/News/NewsController.class.php <?php namespace Applications\Frontend\Modules\News; class NewsController extends \Library\BackController { public function executeIndex(\Library\HTTPRequest $request) { $nombreNews = $this->app->config()->get('nombre_news'); $nombreCaracteres = $this->app->config()>get('nombre_caracteres'); // On ajoute une dfinition pour le titre. $this->page->addVar('title', 'Liste des '.$nombreNews.' dernires news'); // On rcupre le manager des news. $manager = $this->managers->getManagerOf('News'); // Cette ligne, vous ne pouviez pas la deviner sachant qu'on n'a pas encore touch au modle. // Contentez-vous donc d'crire cette instruction, nous implmenterons la mthode ensuite. $listeNews = $manager->getList(0, $nombreNews); foreach ($listeNews as $news) { if (strlen($news->contenu()) > $nombreCaracteres) { $debut = substr($news->contenu(), 0, $nombreCaracteres); $debut = substr($debut, 0, strrpos($debut, ' ')) . '...'; } $news->setContenu($debut);
Comme vous le voyez, j'utilise le fichier de configuration pour rcuprer le nombre de news afficher et le nombre maximum de caractres. V oici le fichier de configuration : Code : XML - /Applications/Frontend/Config/app.xml <?xml version="1.0" encoding="utf-8" ?> <definitions> <define var="nombre_news" value="5" /> <define var="nombre_caracteres" value="200" /> </definitions>
La vue
toute action correspond une vue du mme nom. Ici, la vue crer sera /Applications/Frontend/Modules/News/Views/index.php. V oici un exemple trs simple pour cette vue :
www.siteduzero.com
276/333
Notez l'utilisation des news comme des tableaux : cela est possible du fait que l'objet est une instance d'une classe qui implmente ArrayAccess.
Le modle
Nous allons modifier deux classes faisant partie du modle, savoir NewsManager et NewsManager_PDO. Nous allons implmenter cette dernire classe une mthode : getList(). Sa classe parente doit donc aussi tre modifie pour dclarer cette mthode. Code : PHP - /Library/Models/NewsManager.class.php <?php namespace Library\Models; abstract class NewsManager extends \Library\Manager { /** * Mthode retournant une liste de news demande * @param $debut int La premire news slectionner * @param $limite int Le nombre de news slectionner * @return array La liste des news. Chaque entre est une instance de News. */ abstract public function getList($debut = -1, $limite = -1); }
Code : PHP - /Library/Models/NewsManager_PDO.class.php <?php namespace Library\Models; use \Library\Entities\News; class NewsManager_PDO extends NewsManager { public function getList($debut = -1, $limite = -1) { $sql = 'SELECT id, auteur, titre, contenu, dateAjout, dateModif FROM news ORDER BY id DESC'; if ($debut != -1 || $limite != -1) { $sql .= ' LIMIT '.(int) $limite.' OFFSET '.(int) $debut; } $requete = $this->dao->query($sql); $requete->setFetchMode(\PDO::FETCH_CLASS | \PDO::FETCH_PROPS_LATE, '\Library\Entities\News'); $listeNews = $requete->fetchAll();
www.siteduzero.com
277/333
V ous pouvez faire le test : accdez la racine de votre site et vous dcouvrirez... un gros blanc, car aucune news n'est prsente en BDD .V ous pouvez en ajouter manuellement via phpMyAdmin en attendant que nous ayons construit l'espace d'administration. Si la constante PDO::FETCH_CLASS vous est inconnue, je vous invite relire la premire partie du TP sur la ralisation d'un systme de news.
L'action show
La route
Je vous propose que les URL du type news-id.html pointent vers cette action. Modifiez donc le fichier de configuration des routes pour y ajouter celle-ci : Code : XML - /Applications/Frontend/Config/routes.xml <?xml version="1.0" encoding="utf-8" ?> <routes> <route url="/" module="News" action="index" /> <route url="/news-([0-9]+)\.html" module="News" action="show" vars="id"/> </routes>
Le contrleur
Le contrleur implmentera la mthode executeShow(). Son contenu est simple : le contrleur ira demander au manager la news correspondant l'identifiant puis, il passera cette news la vue, en ayant pris soin de remplacer les sauts de lignes par des balises <br /> dans le contenu de la news. Si la news n'existe pas, il faudra rediriger l'utilisateur vers une erreur 404.
Code : PHP - /Applications/Frontend/Modules/News <?php namespace Applications\Frontend\Modules\News; class NewsController extends \Library\BackController { public function executeIndex(\Library\HTTPRequest $request) { $nombreNews = $this->app->config()->get('nombre_news'); $nombreCaracteres = $this->app->config()>get('nombre_caracteres');
www.siteduzero.com
278/333
public function executeShow(\Library\HTTPRequest $request) { $news = $this->managers->getManagerOf('News')>getUnique($request->getData('id')); if (empty($news)) { $this->app->httpResponse()->redirect404(); } $this->page->addVar('title', $news->titre()); $this->page->addVar('news', $news);
La vue
La vue se contente de grer l'affichage de la news. Faites comme bon vous semble, cela n'a pas trop d'importance. V oici la version que je vous propose : Code : PHP - /Applications/Frontend/Modules/News/Views/show.php <p>Par <em><?php echo $news['auteur']; ?></em>, le <?php echo $news['dateAjout']->format('d/m/Y H\hi'); ?></p> <h2><?php echo $news['titre']; ?></h2> <p><?php echo nl2br($news['contenu']); ?></p> <?php if ($news['dateAjout'] != $news['dateModif']) { ?> <p style="text-align: right;"><small><em>Modifie le <?php echo $news['dateModif']->format('d/m/Y H\hi'); ?></em></small></p> <?php } ?>
Le modle
Nous allons l aussi toucher nos classes NewsManager et NewsManager_PDO en ajoutant la mthode getUnique(). Code : PHP - /Library/Models/NewsManager.class.php
www.siteduzero.com
279/333
Code : PHP - /Library/Models/NewsManager_PDO.class.php <?php namespace Library\Models; use \Library\Entities\News; class NewsManager_PDO extends NewsManager { public function getList($debut = -1, $limite = -1) { $sql = 'SELECT id, auteur, titre, contenu, dateAjout, dateModif FROM news ORDER BY id DESC'; if ($debut != -1 || $limite != -1) { $sql .= ' LIMIT '.(int) $limite.' OFFSET '.(int) $debut; } $requete = $this->dao->query($sql); $requete->setFetchMode(\PDO::FETCH_CLASS | \PDO::FETCH_PROPS_LATE, '\Library\Entities\News'); $listeNews = $requete->fetchAll(); foreach ($listeNews as $news) { $news->setDateAjout(new \DateTime($news->dateAjout())); $news->setDateModif(new \DateTime($news->dateModif())); } $requete->closeCursor(); } return $listeNews;
public function getUnique($id) { $requete = $this->dao->prepare('SELECT id, auteur, titre, contenu, dateAjout, dateModif FROM news WHERE id = :id'); $requete->bindValue(':id', (int) $id, \PDO::PARAM_INT); $requete->execute(); $requete->setFetchMode(\PDO::FETCH_CLASS |
www.siteduzero.com
280/333
return null;
Puisque nous connaissons la structure d'un commentaire, nous pouvons crire une partie du modle, savoir la classe Comment : Code : PHP - /Library/Entities/Comment.class.php <?php namespace Library\Entities; class Comment extends \Library\Entity { protected $news, $auteur, $contenu, $date; const AUTEUR_INVALIDE = 1; const CONTENU_INVALIDE = 2; public function isValid()
www.siteduzero.com
281/333
// SETTERS public function setNews($news) { $this->news = (int) $news; } public function setAuteur($auteur) { if (!is_string($auteur) || empty($auteur)) { $this->erreurs[] = self::AUTEUR_INVALIDE; } else { $this->auteur = $auteur; } } public function setContenu($contenu) { if (!is_string($contenu) || empty($contenu)) { $this->erreurs[] = self::CONTENU_INVALIDE; } else { $this->contenu = $contenu; } } public function setDate(\DateTime $date) { $this->date = $date; } // GETTERS public function news() { return $this->news; } public function auteur() { return $this->auteur; } public function contenu() { return $this->contenu; } public function date() { return $this->date; }
L'action insertComment
La route
www.siteduzero.com
282/333
Nous n'allons pas faire dans la fantaisie pour cette action, nous allons prendre une URL basique : commenter-idnews.html . Rajoutez donc cette nouvelle route dans le fichier de configuration des routes : Code : XML - /Applications/Frontend/Config/routes.xml <?xml version="1.0" encoding="utf-8" ?> <routes> <route url="/" module="News" action="index" /> <route url="/news-([0-9]+)\.html" module="News" action="show" vars="id"/> <route url="/commenter-([0-9]+)\.html" module="News" action="insertComment" vars="news" /> </routes>
La vue
Dans un premier temps, nous allons nous attarder sur la vue car c'est l'intrieur de celle-ci que nous allons construire le formulaire. Cela nous permettra donc de savoir quels champs seront traiter par le contrleur. Je vous propose un formulaire trs simple demandant le pseudo et le contenu l'utilisateur : Code : PHP - /Applications/Frontend/Modules/News/Views/insertComment.php <h2>Ajouter un commentaire</h2> <form action="" method="post"> <p> <?php if (isset($erreurs) && in_array(\Library\Entities\Comment::AUTEUR_INVALIDE, $erreurs)) echo 'L\'auteur est invalide.<br />'; ?> <label>Pseudo</label> <input type="text" name="pseudo" value="<?php if (isset($comment)) echo htmlspecialchars($comment['auteur']); ?>" /><br /> <?php if (isset($erreurs) && in_array(\Library\Entities\Comment::CONTENU_INVALIDE, $erreurs)) echo 'Le contenu est invalide.<br />'; ?> <label>Contenu</label> <textarea name="contenu" rows="7" cols="50"><?php if (isset($comment)) echo htmlspecialchars($comment['contenu']); ? ></textarea><br /> <input type="submit" value="Commenter" /> </p> </form>
L'identifiant de la news est stock dans l'URL. Puisque nous allons envoyer le formulaire sur cette mme page, l'identifiant de la news sera toujours prsent dans l'URL et donc accessible via le contrleur.
Le contrleur
Notre mthode executeInsertComment() se chargera dans un premier temps de vrifier si le formulaire a t envoy en vrifiant si la variable POST pseudo existe. Ensuite, elle procdera la vrification des donnes et insrera le commentaire en BDD si toutes les donnes sont valides. Code : PHP - /Applications/Frontend/Modules/News/NewsController.class.php <?php namespace Applications\Frontend\Modules\News; class NewsController extends \Library\BackController
www.siteduzero.com
283/333
public function executeInsertComment(\Library\HTTPRequest $request) { $this->page->addVar('title', 'Ajout d\'un commentaire'); if ($request->postExists('pseudo')) { $comment = new \Library\Entities\Comment(array( 'news' => $request->getData('news'), 'auteur' => $request->postData('pseudo'), 'contenu' => $request->postData('contenu') )); if ($comment->isValid()) { $this->managers->getManagerOf('Comments')->save($comment); $this->app->user()->setFlash('Le commentaire a bien t ajout, merci !'); $this->app->httpResponse()->redirect('news-'.$request>getData('news').'.html'); } else { $this->page->addVar('erreurs', $comment->erreurs()); } } $this->page->addVar('comment', $comment);
} }
// ...
Le modle
Nous aurons besoin d'implmenter une mthode dans notre classe CommentsManager : save(). En fait, il s'agit d'un raccourci , cette mthode appelle elle-mme une autre mthode : add() ou modify() selon si le commentaire est dj prsent en BDD. Notre manager peut savoir si l'enregistrement est dj enregistr ou pas grce la mthode isNew(). Code : PHP - /Library/Models/CommentsManager.class.php <?php namespace Library\Models; use \Library\Entities\Comment; abstract class CommentsManager extends \Library\Manager { /** * Mthode permettant d'ajouter un commentaire * @param $comment Le commentaire ajouter * @return void */ abstract protected function add(Comment $comment); /** * Mthode permettant d'enregistrer un commentaire. * @param $comment Le commentaire enregistrer * @return void */ public function save(Comment $comment)
www.siteduzero.com
284/333
Code : PHP - /Library/Models/CommentsManager_PDO.class.php <?php namespace Library\Models; use \Library\Entities\Comment; class CommentsManager_PDO extends CommentsManager { protected function add(Comment $comment) { $q = $this->dao->prepare('INSERT INTO comments SET news = :news, auteur = :auteur, contenu = :contenu, date = NOW()'); $q->bindValue(':news', $comment->news(), \PDO::PARAM_INT); $q->bindValue(':auteur', $comment->auteur()); $q->bindValue(':contenu', $comment->contenu()); $q->execute(); } $comment->setId($this->dao->lastInsertId());
www.siteduzero.com
285/333
www.siteduzero.com
286/333
<?php namespace Library\Models; use \Library\Entities\Comment; abstract class CommentsManager extends \Library\Manager { /** * Mthode permettant d'ajouter un commentaire. * @param $comment Le commentaire ajouter * @return void */ abstract protected function add(Comment $comment); /** * Mthode permettant d'enregistrer un commentaire. * @param $comment Le commentaire enregistrer * @return void */ public function save(Comment $comment) { if ($comment->isValid()) { $comment->isNew() ? $this->add($comment) : $this>modify($comment); } else { throw new \RuntimeException('Le commentaire doit tre valid pour tre enregistr'); } } /** * Mthode permettant de rcuprer une liste de commentaires. * @param $news La news sur laquelle on veut rcuprer les commentaires * @return array */ abstract public function getListOf($news); }
Code : PHP - /Library/Models/CommentsManager_PDO.class.php <?php namespace Library\Models; use \Library\Entities\Comment; class CommentsManager_PDO extends CommentsManager { protected function add(Comment $comment) { $q = $this->dao->prepare('INSERT INTO comments SET news = :news, auteur = :auteur, contenu = :contenu, date = NOW()'); $q->bindValue(':news', $comment->news(), \PDO::PARAM_INT); $q->bindValue(':auteur', $comment->auteur()); $q->bindValue(':contenu', $comment->contenu()); $q->execute(); } $comment->setId($this->dao->lastInsertId());
www.siteduzero.com
287/333
www.siteduzero.com
288/333
Le backend
Notre application est compose d'un systme de news avec commentaires. Or, nous ne pouvons actuellement pas ajouter de news, ni modrer les commentaires. Pour ce faire, nous allons crer un espace d'administration, qui n'est autre ici que le backend. Cet espace d'administration sera ainsi compos d'un systme de gestion de news (ajout, modification et suppression) ainsi que d'un systme de gestion de commentaires (modification et suppression). Ayant dj cr le frontend , ce chapitre devrait tre plus facile pour vous. Nanmoins, une nouveaut fait son apparition : celle d'interdire le contenu de l'application aux visiteurs. Ne tranons donc pas, nous avons pas mal de travail qui nous attend !
L'application
Comme pour l'application Frontend , nous aurons besoin de crer les fichiers de base : la classe reprsentant l'application, le layout, les deux fichiers de configuration et le fichier qui instanciera notre classe. Assurez-vous galement d'avoir cr le dossier /Applications/Backend.
La classe BackendApplication
Cette classe ne sera pas strictement identique la classe FrontendApplication. En effet, nous devons scuriser l'application afin que seuls les utilisateurs authentifis y aient accs. Pour rappel, voici le fonctionnement de la mthode run() de la classe FrontendApplication : Obtention du contrleur grce la mthode parente getController(). Excution du contrleur. Assignation de la page cre par le contrleur la rponse. Envoi de la rponse.
La classe BackendApplication fonctionnera de la mme faon, la diffrence prs que la premire instruction ne sera excute que si l'utilisateur est authentifi. Sinon, nous allons rcuprer le contrleur du module de connexion que nous allons crer dans ce chapitre. V oici donc le fonctionnement de la mthode run() de la classe BackendApplication : Si l'utilisateur est authentifi : obtention du contrleur grce la mthode parente getController(). Sinon : instanciation du contrleur du module de connexion. Excution du contrleur. Assignation de la page cre par le contrleur la rponse. Envoi de la rponse.
Aide : nous avons un attribut $user dans notre classe qui reprsente l'utilisateur. Regardez les mthodes que nous lui avons implmentes si vous ne savez pas comment on peut savoir s'il est authentifi ou non. Rappel : n'oubliez pas d'inclure l'autoload au dbut du fichier ! V ous devriez avoir une classe de ce type : Code : PHP - /Applications/Backend/BackendApplication.class.php <?php namespace Applications\Backend; class BackendApplication extends \Library\Application { public function __construct() { parent::__construct(); } $this->name = 'Backend';
www.siteduzero.com
289/333
Le layout
Le layout est le mme que celui du frontend . Sachez qu'en pratique, cela est rare et vous aurez gnralement deux layouts diffrents (chaque application a ses spcificits). Cependant, ici il n'est pas ncessaire de faire deux fichiers diffrents. V ous pouvez donc soit copier/coller le layout du frontend dans le dossier /Applications/Backend/Templates , soit crer le layout et inclure celui du frontend : Code : PHP - /Applications/Backend/Templates/layout.php <?php require dirname(__FILE__).'/../../Frontend/Templates/layout.php';
L'instanciation de BackendApplication
L'instanciation de BackendApplication se fera dans le fichier /Web/backend.php, comme nous avons procd pour l'instanciation de FrontendApplication. Rappel : pensez inclure l'autoload avant d'instancier la classe BackendApplication !
www.siteduzero.com
290/333
Code : PHP - /Web/backend.php <?php require '../Library/autoload.php'; $app = new Applications\Backend\BackendApplication; $app->run();
Le module de connexion
Ce module est un peu particulier. En effet, aucune route ne sera dfinie pour pointer vers ce module. De plus, ce module ne ncessite aucun stockage de donnes, nous n'aurons donc pas de modle. La seule fonctionnalit attendue du module est d'afficher son index. Cet index aura pour rle d'afficher le formulaire de connexion et de traiter les donnes de ce formulaire. Avant de commencer construire le module, nous allons prparer le terrain. O stocker l'identifiant et le mot de passe permettant d'accder l'application ? Je vous propose tout simplement d'ajouter deux dfinitions dans le fichier de configuration de l'application : Code : XML - /Applications/Backend/Config/app.xml <?xml version="1.0" encoding="utf-8" ?> <definitions> <define var="login" value="admin" /> <define var="pass" value="mdp" /> </definitions>
La vue
Nous allons dbuter par crer la vue correspondant l'index du module. Ce sera un simple formulaire demandant le nom d'utilisateur et le mot de passe l'internaute : Code : PHP - /Applications/Backend/Modules/Connexion/Views/index.php <h2>Connexion</h2> <form action="" method="post">
www.siteduzero.com
291/333
Le contrleur
Procdons maintenant l'laboration du contrleur. Ce contrleur implmentera une seule mthode : executeIndex(). Cette mthode devra, si le formulaire a t envoy, vrifier si le pseudo et le mot de passe entrs sont corrects. Si c'est le cas, l'utilisateur est authentifi, sinon un message d'erreur s'affiche. Code : PHP - /Applications/Backend/Modules/Connexion/ConnexionController.class.php <?php namespace Applications\Backend\Modules\Connexion; class ConnexionController extends \Library\BackController { public function executeIndex(\Library\HTTPRequest $request) { $this->page->addVar('title', 'Connexion'); if ($request->postExists('login')) { $login = $request->postData('login'); $password = $request->postData('password'); if ($login == $this->app->config()->get('login') && $password == $this->app->config()->get('pass')) { $this->app->user()->setAuthenticated(true); $this->app->httpResponse()->redirect('.'); } else { $this->app->user()->setFlash('Le pseudo ou le mot de passe est incorrect.'); } } } }
Ce fut court, mais essentiel. Nous venons de scuriser en un rien de temps l'application toute entire. De plus, ce module est rutilisable dans d'autres projets ! En effet, rien ne le lie cette application. partir du moment o l'application aura un fichier de configuration adapt (c'est--dire qu'il a dclar les variables login et pass), alors elle pourra s'en servir.
Le module de news
Nous allons maintenant attaquer le module de news sur notre application. Comme d'habitude, nous commenons par la liste des fonctionnalits attendues.
Fonctionnalits
Ce module doit nous permettre de grer le contenu de la base de donnes. Par consquent, nous devons avoir quatre actions : L'action index qui nous affiche la liste des news avec des liens pour les modifier ou supprimer. L'action insert pour ajouter une news. L'action update pour modifier une news. L'action delete pour supprimer une news.
www.siteduzero.com
292/333
L'action index
La route
Tout d'abord, dfinissons l'URL qui pointera vers cette action. Je vous propose tout simplement que ce soit l'accueil de l'espace d'administration : Code : XML - /Applications/Backend/Config/routes.xml <?xml version="1.0" encoding="utf-8" ?> <routes> <route url="/admin/" module="News" action="index" /> </routes>
Le contrleur
Le contrleur se chargera uniquement de passer la liste des news la vue ainsi que le nombre de news prsent. Le contenu de la mthode est donc assez simple : Code : PHP - /Applications/Backend/Modules/News/NewsController.class.php <?php namespace Applications\Backend\Modules\News; class NewsController extends \Library\BackController { public function executeIndex(\Library\HTTPRequest $request) { $this->page->addVar('title', 'Gestion des news'); $manager = $this->managers->getManagerOf('News'); $this->page->addVar('listeNews', $manager->getList()); $this->page->addVar('nombreNews', $manager->count());
Comme vous le voyez, nous nous resservons de la mthode getList() que nous avions implmente au cours du prcdent chapitre au cours de la construction du frontend . Cependant, il nous reste implmenter une mthode dans notre manager : count().
Le modle
La mthode count() est trs simple : elle ne fait qu'excuter une requte pour renvoyer le rsultat. Code : PHP - /Library/Models/NewsManager.class.php <?php namespace Library\Models; abstract class NewsManager extends \Library\Manager { /** * Mthode renvoyant le nombre de news total. * @return int */ abstract public function count();
www.siteduzero.com
293/333
Code : PHP - /Library/Models/NewsManager_PDO.class.php <?php namespace Library\Models; class NewsManager_PDO extends NewsManager { public function count() { return $this->dao->query('SELECT COUNT(*) FROM news')>fetchColumn(); } } // ...
La vue
La vue se contente de parcourir le tableau de news pour en afficher les donnes. Faites dans la simplicit. Code : PHP - /Applications/Backend/Modules/News/Views/index.php <p style="text-align: center">Il y a actuellement <?php echo $nombreNews; ?> news. En voici la liste :</p> <table> <tr><th>Auteur</th><th>Titre</th><th>Date d'ajout</th><th>Dernire modification</th><th>Action</th></tr> <?php foreach ($listeNews as $news) { echo '<tr><td>', $news['auteur'], '</td><td>', $news['titre'], '</td><td>le ', $news['dateAjout']->format('d/m/Y H\hi'), '</td><td>', ($news['dateAjout'] == $news['dateModif'] ? '-' : 'le '.$news['dateModif']->format('d/m/Y H\hi')), '</td><td><a href="news-update-', $news['id'], '.html"><img src="/images/update.png" alt="Modifier" /></a> <a href="news-delete', $news['id'], '.html"><img src="/images/delete.png" alt="Supprimer" /></a></td></tr>', "\n"; } ?> </table>
L'action insert
La route
Je vous propose que l'URL qui pointera vers cette action soit /admin/news-insert.html . Je pense que maintenant vous savez comment dfinir une route, mais je remets le fichier pour que tout le monde suive bien : Code : XML - /Applications/Backend/Config/routes.xml <?xml version="1.0" encoding="utf-8" ?> <routes> <route url="/admin/" module="News" action="index" /> <route url="/admin/news-insert\.html" module="News"
www.siteduzero.com
294/333
Le contrleur
Le contrleur vrifie si le formulaire a t envoy. Si c'est le cas, alors il procdera la vrification des donnes et insrera la news en BDD si tout est valide. Cependant, il y a un petit problme : lorsque nous implmenterons l'action update, nous allons devoir rcrire la partie traitement du formulaire car la validation des donnes suit la mme logique. Nous allons donc crer une autre mthode au sein du contrleur, nomme processForm(), qui se chargera de traiter le formulaire et d'enregistrer la news en BDD. Rappel : le manager contient une mthode save() qui se chargera soit d'ajouter la news si elle est nouvelle, soit de la mettre jour si elle est dj enregistre. C'est cette mthode que vous devez invoquer.
Code : PHP - /Applications/Backend/Modules/News/NewsController.class.php <?php namespace Applications\Backend\Modules\News; class NewsController extends \Library\BackController { // ... public function executeInsert(\Library\HTTPRequest $request) { if ($request->postExists('auteur')) { $this->processForm($request); } } $this->page->addVar('title', 'Ajout d\'une news');
public function processForm(\Library\HTTPRequest $request) { $news = new \Library\Entities\News( array( 'auteur' => $request->postData('auteur'), 'titre' => $request->postData('titre'), 'contenu' => $request->postData('contenu') ) ); // L'identifiant de la news est transmis si on veut la modifier. if ($request->postExists('id')) { $news->setId($request->postData('id')); } if ($news->isValid()) { $this->managers->getManagerOf('News')->save($news); $this->app->user()->setFlash($news->isNew() ? 'La news a bien t ajoute !' : 'La news a bien t modifie !'); } else { $this->page->addVar('erreurs', $news->erreurs()); } } $this->page->addVar('news', $news);
www.siteduzero.com
295/333
Le modle
Nous allons implmenter les mthodes save() et add() dans notre manager afin que notre contrleur puisse tre fonctionnel. Rappel : la mthode save() s'implmente directement dans NewsManager puisqu'elle ne dpend pas du DAO.
Code : PHP - /Library/Models/NewsManager.class.php <?php namespace Library\Models; use \Library\Entities\News; abstract class NewsManager extends \Library\Manager { /** * Mthode permettant d'ajouter une news. * @param $news News La news ajouter * @return void */ abstract protected function add(News $news); /** * Mthode permettant d'enregistrer une news. * @param $news News la news enregistrer * @see self::add() * @see self::modify() * @return void */ public function save(News $news) { if ($news->isValid()) { $news->isNew() ? $this->add($news) : $this->modify($news); } else { throw new \RuntimeException('La news doit tre valide pour tre enregistre'); } } } // ...
Code : PHP - /Library/Models/NewsManager_PDO.class.php <?php namespace Library\Models; use \Library\Entities\News; class NewsManager_PDO extends NewsManager { protected function add(News $news) { $requete = $this->dao->prepare('INSERT INTO news SET auteur = :auteur, titre = :titre, contenu = :contenu, dateAjout = NOW(), dateModif = NOW()');
www.siteduzero.com
296/333
// ...
La vue
L aussi, nous utiliserons de la duplication de code pour afficher le formulaire. En effet, la vue correspondant l'action update devra galement afficher ce formulaire. Nous allons donc crer un fichier qui contiendra ce formulaire et qui sera inclus au sein des vues. Je vous propose de l'appeler _form.php (le _ est ici utilis pour bien indiquer qu'il ne s'agit pas d'une vue mais d'un lment inclure). Code : PHP - /Applications/Backend/Modules/News/Views/insert.php <h2>Ajouter une news</h2> <?php require '_form.php';
Code : PHP - /Applications/Backend/Modules/News/Views/_form.php <form action="" method="post"> <p> <?php if (isset($erreurs) && in_array(\Library\Entities\News::AUTEUR_INVALIDE, $erreurs)) echo 'L\'auteur est invalide.<br />'; ?> <label>Auteur</label> <input type="text" name="auteur" value="<?php if (isset($news)) echo $news['auteur']; ?>" /><br /> <?php if (isset($erreurs) && in_array(\Library\Entities\News::TITRE_INVALIDE, $erreurs)) echo 'Le titre est invalide.<br />'; ?> <label>Titre</label><input type="text" name="titre" value="<?php if (isset($news)) echo $news['titre']; ?>" /><br /> <?php if (isset($erreurs) && in_array(\Library\Entities\News::CONTENU_INVALIDE, $erreurs)) echo 'Le contenu est invalide.<br />'; ?> <label>Contenu</label><textarea rows="8" cols="60" name="contenu"><?php if (isset($news)) echo $news['contenu']; ? ></textarea><br /> <?php if(isset($news) && !$news->isNew()) { ?> <input type="hidden" name="id" value="<?php echo $news['id']; ? >" /> <input type="submit" value="Modifier" name="modifier" /> <?php } else { ?> <input type="submit" value="Ajouter" /> <?php } ?> </p> </form>
www.siteduzero.com
297/333
L'action update
La route
Pas d'originalit ici, nous allons choisir une URL basique : /admin/news-update-id .html . Code : XML - /Applications/Backend/Config/routes.xml <?xml version="1.0" encoding="utf-8" ?> <routes> <route url="/admin/" module="News" action="index" /> <route url="/admin/news-insert\.html" module="News" action="insert" /> <route url="/admin/news-update-([0-9]+)\.html" module="News" action="update" vars="id" /> </routes>
Le contrleur
La mthode executeUpdate() est quasiment identique executeInsert(). La seule diffrence est qu'il faut passer la news la vue si le formulaire n'a pas t envoy. Code : PHP - /Applications/Backend/Modules/News/NewsController.class.php <?php namespace Applications\Backend\Modules\News; class NewsController extends \Library\BackController { // ... public function executeUpdate(\Library\HTTPRequest $request) { if ($request->postExists('auteur')) { $this->processForm($request); } else { $this->page->addVar('news', $this->managers>getManagerOf('News')->getUnique($request->getData('id'))); } } } $this->page->addVar('title', 'Modification d\'une news');
// ...
Le modle
Ce code fait appel deux mthodes : getUnique() et modify(). La premire a dj t implmente au cours du prcdent chapitre et la seconde avait volontairement t laisse de ct. Il est maintenant temps de l'implmenter. Code : PHP - /Library/Models/NewsManager.class.php <?php
www.siteduzero.com
298/333
Code : PHP - /Library/Models/NewsManager_PDO.class.php <?php namespace Library\Models; use \Library\Entities\News; class NewsManager_PDO extends NewsManager { // ... protected function modify(News $news) { $requete = $this->dao->prepare('UPDATE news SET auteur = :auteur, titre = :titre, contenu = :contenu, dateModif = NOW() WHERE id = :id'); $requete->bindValue(':titre', $news->titre()); $requete->bindValue(':auteur', $news->auteur()); $requete->bindValue(':contenu', $news->contenu()); $requete->bindValue(':id', $news->id(), \PDO::PARAM_INT); } } $requete->execute();
// ...
La vue
De la mme faon que pour l'action insert , ce procd tient en deux lignes : il s'agit seulement d'inclure le formulaire, c'est tout ! Code : PHP - /Applications/Backend/Modules/News/Views/update.php <h2>Modifier une news</h2> <?php require '_form.php';
L'action delete
La route
Pour continuer dans l'originalit, l'URL qui pointera vers cette action sera du type /admin/news-delete-id .html .
www.siteduzero.com
299/333
Le contrleur
Le contrleur se chargera d'invoquer la mthode du manager qui supprimera la news. Ensuite, il redirigera l'utilisateur l'accueil de l'espace d'administration en ayant pris soin de spcifier un message qui s'affichera au prochain chargement de page. Ainsi, cette action ne possdera aucune vue. Code : PHP - /Applications/Backend/Modules/News/NewsController.class.php <?php namespace Applications\Backend\Modules\News; class NewsController extends \Library\BackController { // ... public function executeDelete(\Library\HTTPRequest $request) { $this->managers->getManagerOf('News')->delete($request>getData('id')); $this->app->user()->setFlash('La news a bien t supprime !'); } } $this->app->httpResponse()->redirect('.');
// ...
Le modle
Ici, une simple requte de type DELETE suffit. Code : PHP - /Library/Models/NewsManager.class.php <?php namespace Library\Models; use \Library\Entities\News; abstract class NewsManager extends \Library\Manager { // ... /** * Mthode permettant de supprimer une news. * @param $id int L'identifiant de la news supprimer * @return void
www.siteduzero.com
300/333
Code : PHP - /Library/Model/NewsManager_PDO.class.php <?php namespace Library\Models; use \Library\Entities\News; class NewsManager_PDO extends NewsManager { // ... public function delete($id) { $this->dao->exec('DELETE FROM news WHERE id = '.(int) $id); } } // ...
Fonctionnalits
Nous allons faire simple et implmenter deux fonctionnalits : La modification de commentaires. La suppression de commentaires.
L'action updateComment
La route
Commenons, comme d'habitude, par dfinir l'URL qui pointera vers ce module. Je vous propose quelque chose de simple comme /admin/comments-update-id .html . Code : XML - /Applications/Backend/Config/routes.xml <?xml version="1.0" encoding="utf-8" ?> <routes> <route url="/admin/" module="News" action="index" /> <route url="/admin/news-insert\.html" module="News" action="insert" /> <route url="/admin/news-update-([0-9]+)\.html" module="News" action="update" vars="id" /> <route url="/admin/news-delete-([0-9]+)\.html" module="News" action="delete" vars="id" /> <route url="/admin/comment-update-([0-9]+)\.html" module="News" action="updateComment" vars="id" /> </routes>
Le contrleur
La mthode que l'on implmentera aura pour rle de contrler les valeurs du formulaire et de modifier le commentaire en BDD si
www.siteduzero.com
301/333
tout est valide. V ous devriez avoir quelque chose de semblable ce que nous avons dans l'application Frontend . Il faudra ensuite rediriger l'utilisateur sur la news qu'il lisait. Aide : pour rediriger l'utilisateur sur la news, il va falloir obtenir l'identifiant de cette dernire. Il faudra donc ajouter un champ cach dans le formulaire pour transmettre ce paramtre.
Code : PHP - /Applications/Backend/Modules/News/NewsController.class.php <?php namespace Applications\Backend\Modules\News; class NewsController extends \Library\BackController { // ... public function executeUpdateComment(\Library\HTTPRequest $request) { $this->page->addVar('title', 'Modification d\'un commentaire'); if ($request->postExists('pseudo')) { $comment = new \Library\Entities\Comment(array( 'id' => $request->getData('id'), 'auteur' => $request->postData('pseudo'), 'contenu' => $request->postData('contenu') )); if ($comment->isValid()) { $this->managers->getManagerOf('Comments')->save($comment); $this->app->user()->setFlash('Le commentaire a bien t modifi !'); $this->app->httpResponse()->redirect('/news-'.$request>postData('news').'.html'); } else { $this->page->addVar('erreurs', $comment->erreurs()); } $this->page->addVar('comment', $comment); } else { $this->page->addVar('comment', $this->managers>getManagerOf('Comments')->get($request->getData('id'))); } } } // ...
Le modle
Nous avons ici besoin d'implmenter deux mthodes : modify() et get(). La premire se contente d'excuter une requte de type UPDATE et la seconde une requte de type SELECT. Code : PHP - /Library/Models/CommentsManager.class.php <?php
www.siteduzero.com
302/333
Code : PHP - /Library/Models/CommentsManager_PDO.class.php <?php namespace Library\Models; use \Library\Entities\Comment; class CommentsManager_PDO extends CommentsManager { // ... protected function modify(Comment $comment) { $q = $this->dao->prepare('UPDATE comments SET auteur = :auteur, contenu = :contenu WHERE id = :id'); $q->bindValue(':auteur', $comment->auteur()); $q->bindValue(':contenu', $comment->contenu()); $q->bindValue(':id', $comment->id(), \PDO::PARAM_INT); } $q->execute();
public function get($id) { $q = $this->dao->prepare('SELECT id, news, auteur, contenu FROM comments WHERE id = :id'); $q->bindValue(':id', (int) $id, \PDO::PARAM_INT); $q->execute(); $q->setFetchMode(\PDO::FETCH_CLASS | \PDO::FETCH_PROPS_LATE, '\Library\Entities\Comment'); } return $q->fetch();
La vue
La vue ne fera que contenir le formulaire et afficher les erreurs s'il y en a.
www.siteduzero.com
303/333
www.siteduzero.com
304/333
L'action deleteComment
La route
Faisons l aussi trs simple : nous n'avons qu' prendre une URL du type /admin/comments-delete-id .html . Code : XML - /Applications/Backend/Config/routes.xml <?xml version="1.0" encoding="utf-8" ?> <routes> <route url="/admin/" module="News" action="index" /> <route url="/admin/news-insert\.html" module="News" action="insert" /> <route url="/admin/news-update-([0-9]+)\.html" module="News" action="update" vars="id" /> <route url="/admin/news-delete-([0-9]+)\.html" module="News" action="delete" vars="id" /> <route url="/admin/comment-update-([0-9]+)\.html" module="News" action="updateComment" vars="id" /> <route url="/admin/comment-delete-([0-9]+)\.html" module="News" action="deleteComment" vars="id" /> </routes>
Le contrleur
Il faut dans un premier temps invoquer la mthode du manager permettant de supprimer un commentaire. Redirigez ensuite l'utilisateur sur l'accueil de l'espace d'administration. Code : PHP - /Applications/Backend/Modules/News/NewsController.class.php <?php namespace Applications\Backend\Modules\News; class NewsController extends \Library\BackController { // ... public function executeDeleteComment(\Library\HTTPRequest $request) { $this->managers->getManagerOf('Comments')->delete($request>getData('id')); !'); } $this->app->user()->setFlash('Le commentaire a bien t supprim $this->app->httpResponse()->redirect('.');
www.siteduzero.com
305/333
Le modle
Il suffit ici d'implmenter la mthode delete() excutant une simple requte DELETE. Code : PHP - /Library/Models/CommentsManager.class.php <?php namespace Library\Models; use \Library\Entities\Comment; abstract class CommentsManager extends \Library\Manager { // ... /** * Mthode permettant de supprimer un commentaire. * @param $id L'identifiant du commentaire supprimer * @return void */ abstract public function delete($id); } // ...
Code : PHP - /Library/Models/CommentsManager_PDO.class.php <?php namespace Library\Models; use \Library\Entities\Comment; class CommentsManager_PDO extends CommentsManager { // ... public function delete($id) { $this->dao->exec('DELETE FROM comments WHERE id = '.(int) $id); } } // ...
www.siteduzero.com
306/333
www.siteduzero.com
307/333
Cependant, vous conviendrez qu'il est long et fastidieux de crer ce formulaire. De plus, si nous voulons diter un commentaire, il va falloir le dupliquer dans l'application backend . Dans un premier temps, nous allons nous occuper de l'aspect long et fastidieux : laissons un objet gnrer tous ces champs notre place !
L'objet Form
Comme nous venons de le voir, un formulaire n'est autre qu'une liste de champs . V ous connaissez donc dj le rle de cet objet : il sera charg de reprsenter le formulaire en possdant une liste de champs. Commenons alors la liste des fonctionnalits de notre formulaire. Notre formulaire contient divers champs. Nous devons donc pouvoir ajouter des champs notre formulaire. Ensuite, que serait un formulaire si on ne pouvait pas l'afficher ? Dans notre cas, le formulaire ne doit pas tre capable de s'afficher mais de gnrer tous les champs qui lui sont attachs afin que le contrleur puisse rcuprer le corps du formulaire pour le passer la vue. Enfin, notre formulaire doit possder une dernire fonctionnalit : le capacit de dclarer si le formulaire est valide ou non en vrifiant que chaque champ l'est. Pour rsumer, nous avons donc trois fonctionnalits. Un objet Form doit tre capable : D'ajouter des champs sa liste de champs. De gnrer le corps du formulaire. De vrifier si tous les champs sont valides.
www.siteduzero.com
308/333
Cependant, un formulaire est galement caractris par autre chose. En effet, si je vous demande de me dire comment vous allez vrifier si tous les champs sont valides, vous sauriez comment faire ? aucun moment nous n'avons pass des valeurs notre formulaire, donc aucune vrification n'est effectuer. Il faudrait donc, dans le constructeur de notre objet Form, passer un objet contenant toutes ces valeurs. Ainsi, lors de l'ajout d'un champ, la mthode irait chercher la valeur correspondante dans cet objet et l'assignerait au champ (nous verrons plus tard comment la mthode sait quel attribut de l'entit correspond le champ). votre avis, quoi vont ressembler ces objets ? En fait, vous les avez dj crs ces objets : ce sont toutes les classes filles de Entity ! Par exemple, si vous voulez modifier un commentaire, vous allez crer un objet Comment que vous allez hydrater, puis vous crerez un objet Form en passant l'objet Comment au constructeur. Ainsi, voici notre classe Form schmatise (voir la figure suivante).
V ous pouvez remarquer que la mthode add() renvoie un objet Form. En fait, il s'agit du formulaire auquel on a ajout le champ : cela permet denchaner facilement les appels la mthode add() comme nous le verrons juste aprs.
L'objet Field
Puisque l'objet Form est intimement li ses champs, intressons-nous la conception de ces champs (ou fields en anglais). V ous l'aurez peut-tre devin : tous nos champs seront des objets, chacun reprsentant un champ diffrent (une classe reprsentera un champ texte, une autre classe reprsentera une zone de texte, etc.). ce stade, un tilt devrait s'tre produit dans votre tte : ce sont tous des champs, ils doivent donc hriter d'une mme classe reprsentant leur nature en commun, savoir une classe Field ! Commenons par cette classe Field. Quelles fonctionnalits attendons-nous de cette classe ? Un objet Field doit tre capable : De renvoyer le code HTML reprsentant le champ. De vrifier si la valeur du champ est valide.
Je pense que vous aviez ces fonctionnalits plus ou moins en tte. Cependant, il y a encore une autre fonctionnalit que nous devons implmenter. En effet, pensez aux classes qui hriteront de Field et qui reprsenteront chacune un type de champ. Chaque champ a des attributs spcifiques. Par exemple, un champ texte (sur une ligne) possde un attribut maxlength, tandis qu'une zone de texte (un textarea ) possde des attributs rows et cols. Chaque classe fille aura donc des attributs elles seules. Il serait pratique, ds la construction de l'objet, de passer ces valeurs notre champ (par exemple, assigner 50 l'attribut maxlength). Pour rsoudre ce genre de cas, nous allons procder d'une faon qui ne vous est pas inconnue : nous allons crer une mthode permettant l'objet de s'hydrater ! Ainsi, notre classe Field possdera une mthode hydrate(), comme les entits. V oici la figure suivante le schma reprsentant notre classe Field lie la classe Form, avec deux classes filles en exemple (StringField reprsentant un champ texte sur une ligne et la classe TextField reprsentant un textarea ).
www.siteduzero.com
309/333
Dveloppement de l'API
La classe Form
Pour rappel, voici de quoi la classe Form est compose : D'un attribut stockant la liste des champs . D'un attribut stockant l'entit correspondant au formulaire. D'un constructeur rcuprant l'entit et invoquant le setter correspondant. D'une mthode permettant d'ajouter un champ la liste des champs. D'une mthode permettant de gnrer le formulaire. D'une mthode permettant de vrifier si le formulaire est valide. V oici la classe Form que vous auriez du obtenir : Code : PHP - /Library/Form.class.php
www.siteduzero.com
310/333
public function isValid() { $valid = true; // On vrifie que tous les champs sont valides. foreach ($this->fields as $field) { if (!$field->isValid()) { $valid = false; } } } return $valid;
public function entity() { return $this->entity; } public function setEntity(Entity $entity) { $this->entity = $entity; }
www.siteduzero.com
311/333
Les classes filles, quant elles, n'implmenteront que la mthode abstraite. Si elles possdent des attributs spcifiques (comme l'attribut maxlength pour la classe StringField), alors elles devront implmenter les mutateurs correspondant (comme vous le verrez plus tard, ce n'est pas ncessaire d'implmenter les accesseurs). V oici les trois classes que vous auriez du obtenir (la classe Field avec deux classes filles en exemple, StringField et TextField) : Code : PHP - /Library/Field.class.php <?php namespace Library; abstract class Field { protected $errorMessage; protected $label; protected $name; protected $value; public function __construct(array $options = array()) { if (!empty($options)) { $this->hydrate($options); } } abstract public function buildWidget(); public function hydrate($options) { foreach ($options as $type => $value) { $method = 'set'.ucfirst($type); if (is_callable(array($this, $method))) { $this->$method($value); }
public function isValid() { // On crira cette mthode plus tard. } public function label() { return $this->label; } public function name() { return $this->name; }
www.siteduzero.com
312/333
Code : PHP - /Library/StringField.class.php <?php namespace Library; class StringField extends Field { protected $maxLength; public function buildWidget() { $widget = ''; if (!empty($this->errorMessage)) { $widget .= $this->errorMessage.'<br />'; } $widget .= '<label>'.$this->label.'</label><input type="text" name="'.$this->name.'"'; if (!empty($this->value)) { $widget .= ' value="'.htmlspecialchars($this->value).'"'; } if (!empty($this->maxLength)) { $widget .= ' maxlength="'.$this->maxLength.'"'; } } return $widget .= ' />';
www.siteduzero.com
313/333
Code : PHP - /Library/TextField.class.php <?php namespace Library; class TextField extends Field { protected $cols; protected $rows; public function buildWidget() { $widget = ''; if (!empty($this->errorMessage)) { $widget .= $this->errorMessage.'<br />'; } $widget .= '<label>'.$this->label.'</label><textarea name="'.$this->name.'"'; if (!empty($this->cols)) { $widget .= ' cols="'.$this->cols.'"'; } if (!empty($this->rows)) { $widget .= ' rows="'.$this->rows.'"'; } $widget .= '>'; if (!empty($this->value)) { $widget .= htmlspecialchars($this->value); } } return $widget.'</textarea>';
public function setCols($cols) { $cols = (int) $cols; if ($cols > 0) { $this->cols = $cols; }
www.siteduzero.com
314/333
www.siteduzero.com
315/333
Code : PHP - /Applications/Frontend/Modules/News/Views/insertComment.php <h2>Ajouter un commentaire</h2> <form action="" method="post"> <p> <?php echo $form; ?> <input type="submit" value="Commenter" /> </p> </form>
Cependant, avouez que ce n'est pas pratique d'avoir ceci en plein milieu de notre contrleur. De plus, si nous avons besoin de crer ce formulaire un autre endroit, nous devrons copier/coller tous ces appels la mthode add() et recrer tous les champs. Niveau duplication de code, nous sommes servi ! Nous rsoudrons ce problme dans la suite du chapitre. Mais avant cela, intressons-nous la validation du formulaire. En effet, le contenu de la mthode isValid() est rest vide : faisons appel aux validateurs !
Les validateurs
Un validateur, comme son nom l'indique, est charg de valider une donne. Mais attention : un validateur ne peut valider qu'une contrainte. Par exemple, si vous voulez vrifier que votre valeur n'est pas nulle et qu'elle ne dpasse pas les cinquante caractres, alors vous aurez besoin de deux validateurs : le premier vrifiera que la valeur n'est pas nulle, et le second vrifiera que la chaine de caractres ne dpassera pas les cinquante caractres. L aussi, vous devriez savoir ce qui vous attend au niveau des classes : nous aurons une classe de base (Validator) et une infinit de classes filles (dans le cas prcdent, on peut imaginer les classes NotNullValidator et MaxLengthValidator). Attaquons-les ds maintenant !
www.siteduzero.com
316/333
www.siteduzero.com
317/333
Code : PHP - /Library/MaxLengthValidator.class.php <?php namespace Library; class MaxLengthValidator extends Validator { protected $maxLength; public function __construct($errorMessage, $maxLength) { parent::__construct($errorMessage); } $this->setMaxLength($maxLength);
public function isValid($value) { return strlen($value) <= $this->maxLength; } public function setMaxLength($maxLength) { $maxLength = (int) $maxLength; if ($maxLength > 0) { $this->maxLength = $maxLength; } else { throw new \RuntimeException('La longueur maximale doit tre un nombre suprieur 0'); } } }
www.siteduzero.com
318/333
De cette faon, quelques modifications au niveau de notre classe Field s'imposent. En effet, il va falloir crer un attribut $validators, ainsi que l'accesseur et le mutateur correspondant. De la sorte, notre mthode hydrate() assignera automatiquement les validateurs passs au constructeur l'attribut $validators. Je vous laisse faire cela. Vient maintenant l'implmentation de la mthode isValid(). Cette mthode doit parcourir tous les validateurs et invoquer la mthode isValid($value) sur ces validateurs afin de voir si la valeur passe au travers du filet de tous les validateurs. De cette faon, nous sommes srs que toutes les contraintes ont t respectes ! Si un validateur renvoie une rponse ngative lorsqu'on lui demande si la valeur est valide, alors on devra lui demander le message d'erreur qui lui a t assign et l'assigner notre tour l'attribut correspondant. Ainsi, voici la nouvelle classe Field : Code : PHP - /Library/Field.class.php <?php namespace Library; abstract class Field { protected $errorMessage; protected $label; protected $name; protected $validators = array(); protected $value; public function __construct(array $options = array()) { if (!empty($options)) { $this->hydrate($options); } } abstract public function buildWidget(); public function hydrate($options) { foreach ($options as $type => $value) { $method = 'set'.ucfirst($type); if (is_callable(array($this, $method))) { $this->$method($value); }
public function isValid() { foreach ($this->validators as $validator) { if (!$validator->isValid($this->value)) { $this->errorMessage = $validator->errorMessage(); return false; } }
www.siteduzero.com
319/333
public function label() { return $this->label; } public function length() { return $this->length; } public function name() { return $this->name; } public function validators() { return $this->validators; } public function value() { return $this->value; } public function setLabel($label) { if (is_string($label)) { $this->label = $label; } } public function setLength($length) { $length = (int) $length; if ($length > 0) { $this->length = $length; }
public function setName($name) { if (is_string($name)) { $this->name = $name; } } public function setValidators(array $validators) { foreach ($validators as $validator) { if ($validator instanceof Validator && !in_array($validator, $this->validators)) { $this->validators[] = $validator; } } } public function setValue($value) { if (is_string($value)) {
www.siteduzero.com
320/333
V ous pouvez apercevoir l'utilisation de l'oprateur instanceof dans le code. Pour en savoir plus ce sujet, je vous invite aller lire le chapitre ddi cet oprateur.
Le constructeur de formulaires
Comme nous l'avons vu, crer le formulaire au sein du contrleur prsente deux inconvnients. Premirement, cela encombre le contrleur. Imaginez que vous ayez une dizaine de champs, cela deviendrait norme ! Le contrleur doit tre clair, et la cration du formulaire devrait donc se faire autre part. Deuximement, il y a le problme de duplication de code : si vous voulez utiliser ce formulaire dans un autre contrleur, vous devrez copier/coller tout le code responsable de la cration du formulaire. Pas trs flexible vous en conviendrez ! Pour cela, nous allons donc crer des constructeurs de formulaire. Il y aura par consquent autant de constructeurs que de formulaires diffrents.
www.siteduzero.com
321/333
Modlisation des
www.siteduzero.com
322/333
Code : PHP - /Library/NewsFormBuilder.class.php <?php namespace Library\FormBuilder; class NewsFormBuilder extends \Library\FormBuilder { public function build() { $this->form->add(new \Library\StringField(array( 'label' => 'Auteur', 'name' => 'auteur', 'maxLength' => 20, 'validators' => array( new \Library\MaxLengthValidator('L\'auteur spcifi est trop long (20 caractres maximum)', 20), new \Library\NotNullValidator('Merci de spcifier l\'auteur de la news'), ), ))) ->add(new \Library\StringField(array( 'label' => 'Titre', 'name' => 'titre', 'maxLength' => 100, 'validators' => array( new \Library\MaxLengthValidator('Le titre spcifi est trop long (100 caractres maximum)', 100), new \Library\NotNullValidator('Merci de spcifier le titre de la news'), ), ))) ->add(new \Library\TextField(array( 'label' => 'Contenu', 'name' => 'contenu', 'rows' => 8, 'cols' => 60, 'validators' => array( new \Library\NotNullValidator('Merci de spcifier le contenu de la news'), ), ))); }
www.siteduzero.com
323/333
www.siteduzero.com
324/333
public function executeUpdateComment(\Library\HTTPRequest $request) { $this->page->addVar('title', 'Modification d\'un commentaire'); if ($request->method() == 'POST') { $comment = new \Library\Entities\Comment(array( 'id' => $request->getData('id'), 'auteur' => $request->postData('auteur'), 'contenu' => $request->postData('contenu') )); } else { $comment = $this->managers->getManagerOf('Comments')>get($request->getData('id')); } $formBuilder = new \Library\FormBuilder\CommentFormBuilder($comment); $formBuilder->build(); $form = $formBuilder->form(); if ($request->method() == 'POST' && $form->isValid()) { $this->managers->getManagerOf('Comments')->save($comment); $this->app->user()->setFlash('Le commentaire a bien t modifi'); $this->app->httpResponse()->redirect('/admin/'); } } $this->page->addVar('form', $form->createView());
www.siteduzero.com
325/333
} else { // L'identifiant de la news est transmis si on veut la modifier. if ($request->getExists('id')) { $news = $this->managers->getManagerOf('News')>getUnique($request->getData('id')); } else { $news = new \Library\Entities\News; } } $formBuilder = new \Library\FormBuilder\NewsFormBuilder($news); $formBuilder->build(); $form = $formBuilder->form(); if ($request->method() == 'POST' && $form->isValid()) { $this->managers->getManagerOf('News')->save($news); $this->app->user()->setFlash($news->isNew() ? 'La news a bien t ajoute !' : 'La news a bien t modifie !'); $this->app->httpResponse()->redirect('/admin/'); } } $this->page->addVar('form', $form->createView());
Le gestionnaire de formulaires
Terminons ce chapitre en amliorant encore notre API permettant la cration de formulaire. Je voudrais attirer votre attention sur ce petit passage, que l'on retrouve chaque fois (que ce soit pour ajouter ou modifier une news ou un commentaire) : Code : PHP <?php // Nous sommes ici au sein d'un contrleur if($request->method() == 'POST' && $form->isValid()) { $this->managers->getManagerOf('Manager')->save($comment); // ... }
Bien que rduit, ce bout de code est lui aussi dupliqu. De plus, si l'on veut vraiment externaliser la gestion du formulaire, alors il
www.siteduzero.com
326/333
va falloir le sortir du contrleur. Ainsi, il ne restera plus d'opration de traitement dans le contrleur. On sparera donc bien les rles : le contrleur n'aura plus rflchir sur le formulaire qu'il traite. En effet, il ne fera que demander au constructeur de formulaire de construire le formulaire qu'il veut, puis demandera au gestionnaire de formulaire de s'occuper de lui s'il a t envoy. On ne se souciera donc plus de l'aspect interne du formulaire !
Modlisation de la classe
FormHandler
www.siteduzero.com
327/333
public function setForm(\Library\Form $form) { $this->form = $form; } public function setManager(\Library\Manager $manager) { $this->manager = $manager; } public function setRequest(\Library\HTTPRequest $request) { $this->request = $request; }
Il suffit donc de remplacer ce code par la simple invocation de la mthode process() sur notre objet FormHandler : Code : PHP <?php // On rcupre le gestionnaire de formulaire (le paramtre de getManagerOf() est bien entendu remplacer). $formHandler = new \Library\FormHandler($form, $this->managers>getManagerOf('Comments'), $request); if ($formHandler->process()) { // Ici ne rsident plus que les oprations effectuer une fois l'entit du formulaire enregistre // (affichage d'un message informatif, redirection, etc.). }
Je vous fais confiance pour mettre jour vos contrleurs comme il se doit !
www.siteduzero.com
328/333
Partie 4 : Annexes
V oici ici quelques pages vous prsentant certaines notions que je n'ai pas pu glisser dans le cours au risque de compliquer celuici inutilement. Au dbut de chaque chapitre seront prciss les pr-requis afin de pouvoir suivre sans difficult.
L'oprateur instanceof
V ous tes-vous dj demand s'il tait possible de savoir si un objet tait une instance de telle classe ? Si vous vous tes dj pos cette question, vous n'avez normalement pas trouv de rponse vraiment claire. Un moyen simple de vrifier une telle chose est d'utiliser l'oprateur instanceof. Ce sera un court chapitre car cette notion n'est pas bien difficile. Il faut juste possder quelques pr-rquis. En voici la liste : Bien matriser les notions de classe, d'objet et d'instance . Bien matriser le concept de l'hritage (si vous ne matrisez pas bien la rsolution statique la vole ce n'est pas bien important). Savoir ce qu'est une interface et savoir s'en servir.
Prsentation de l'oprateur
L'oprateur instanceof permet de vrifier si tel objet est une instance de telle classe. C'est un oprateur qui s'utilise dans une condition. Ainsi, on pourra crer des conditions comme si $monObjet est une instance de MaClasse, alors... . Maintenant voyons comment construire notre condition. gauche de notre oprateur,nous allons y placer notre objet. droite de notre oprateur, nous allons placer, comme vous vous en doutez srement, le nom de la classe. Exemple : Code : PHP <?php class A { } class B { } $monObjet = new A; if ($monObjet instanceof A) // Si $monObjet est une instance de A. { echo '$monObjet est une instance de A'; } else { echo '$monObjet n\'est pas une instance de A'; } if ($monObjet instanceof B) // Si $monObjet est une instance de B. { echo '$monObjet est une instance de B'; } else { echo '$monObjet n\'est pas une instance de B'; } ?>
Bref, je pense que vous avez compris le principe. Si votre version de PHP est ultrieure la version 5.1, alors aucune erreur fatale ne sera gnre si vous utilisez l'oprateur instanceof en spcifiant une classe qui n'a pas t dclare. La condition renverra tout simplement false.
www.siteduzero.com
Partie 4 : Annexes
329/333
Il y a cependant plusieurs faons de procder et quelques astuces (c'est d'ailleurs pour toutes les prsenter que j'ai cr ce chapitre). Parmi ces mthodes, il y en a une qui consiste placer le nom de la classe pour laquelle on veut vrifier que tel objet est une instance dans une variable sous forme de chane de caractres. Exemple : Code : PHP <?php class A { } class B { } $monObjet = new A; $classeA = 'A'; $classeB = 'B'; if ($monObjet instanceof $classeA) { echo '$monObjet est une instance de ', $classeA; } else { echo '$monObjet n\'est pas une instance de ', $classeA; } if ($monObjet instanceof $classeB) { echo '$monObjet est une instance de ', $classeB; } else { echo '$monObjet n\'est pas une instance de ', $classeB; } ?>
Attention ! V ous ne pouvez spcifier le nom de la classe entre apostrophes ou guillemets directement dans la condition !V ous devez obligatoirement passer par une variable. Si vous le faites directement, vous obtiendrez une belle erreur d'analyse.
Une autre faon d'utiliser cet oprateur est de spcifier un autre objet la place du nom de la classe. La condition renverra true si les deux objets sont des instances de la mme classe. Exemple : Code : PHP <?php class A { } class B { } $a = new A; $b = new A; $c = new B; if ($a instanceof $b) { echo '$a et $b sont des instances de la mme classe'; } else { echo '$a et $b ne sont pas des instances de la mme classe'; }
www.siteduzero.com
Partie 4 : Annexes
if ($a instanceof $c) { echo '$a et $c sont des instances de la mme classe'; } else { echo '$a et $c ne sont pas des instances de la mme classe'; } ?>
330/333
Et voil. V ous connaissez les trois mthodes possibles pour utiliser cet oprateur. Pourtant, il existe encore quelques effets que peut produire instanceof. Poursuivons donc ce chapitre tranquillement.
instanceof et l'hritage
L'hritage est de retour ! En effet, instanceof a un comportement bien particulier avec les classes qui hritent entre elles. V oici ces effets. V ous vous souvenez sans doute (enfin j'espre ) de la premire faon d'utiliser l'oprateur. V oici une rvlation : la condition renvoie true si la classe spcifie est une classe parente de la classe instancie par l'objet spcifi. Exemple : Code : PHP <?php class A { } class B extends A { } class C extends B { } $b = new B; if ($b instanceof A) { echo '$b est une instance de A ou $b instancie une classe qui est une fille de A'; } else { echo '$b n\'est pas une instance de A et $b instancie une classe qui n\'est pas une fille de A'; } if ($b instanceof C) { echo '$b est une instance de C ou $b instancie une classe qui est une fille de C'; } else { echo '$b n\'est pas une instance de C et $b instancie une classe qui n\'est pas une fille de C'; } ?>
V oil, j'espre que vous avez compris le principe car celui-ci est le mme avec les deuxime et troisime mthodes. Nous allons donc maintenant terminer ce chapitre avec une dernire partie concernant les ractions de l'oprateur avec les interfaces. Ce sera un mlange des deux premires parties, donc si vous tes perdus, relisez bien tout (eh oui, j'espre que vous n'avez pas oubli l'hritage entre interfaces ).
www.siteduzero.com
Partie 4 : Annexes
331/333
Hein ? Comment a ? Je comprends pas... Comment peut-on vrifier qu'un objet soit une instance d'une interface sachant que c'est impossible ?
Comme vous le dites si bien, il est impossible de crer une instance d'une interface (au mme titre que de crer une instance d'une classe abstraite, ce qu'est peu prs une interface). L'oprateur va donc renvoyer true si tel objet instancie une classe implmentant telle interface. V oici un exemple : Code : PHP <?php interface iA { } class A implements iA { } class B { } $a = new A; $b = new B; if ($a instanceof iA) { echo 'Si iA est une classe, alors $a est une instance de iA ou $a instancie une classe qui est une fille de iA. Sinon, $a instancie une classe qui implmente iA.'; } else { echo 'Si iA est une classe, alors $a n\'est pas une instance de iA et $a n\'instancie aucune classe qui est une fille de iA. Sinon, $a instancie une classe qui n\'implmente pas iA.'; } if ($b instanceof iA) { echo 'Si iA est une classe, alors $b est une instance de iA ou $b instancie une classe qui est une fille de iA. Sinon, $b instancie une classe qui implmente iA.'; } else { echo 'Si iA est une classe, alors $b n\'est pas une instance de iA et $b n\'instancie aucune classe qui est une fille de iA. Sinon, $b instancie une classe qui n\'implmente pas iA.'; } ?>
Ce code se passe de commentaires, les valeurs affiches dtaillant assez bien je pense. Aprs avoir vu l'utilisation de l'oprateur avec les interfaces, nous allons voir comment il ragit lorsqu'on lui passe en paramtre une interface qui est hrite par une autre interface qui est implmente par une classe qui est instancie. V ous voyez peu prs quoi je fais srfrence ? Je vais procder en PHP au cas o vous n'ayez pas tout suivi. Code : PHP <?php interface iParent { } interface iFille extends iParent { } class A implements iFille { } $a = new A; if ($a instanceof iParent) {
www.siteduzero.com
Partie 4 : Annexes
echo 'Si iParent est une classe, alors $a est une instance de iParent ou $a instancie une classe qui est une fille de iParent. Sinon, $a instancie une classe qui implmente iParent ou une fille de iParent.'; } else { echo 'Si iParent est une classe, alors $a n\'est pas une instance de iParent et $a n\'instancie aucune classe qui est une fille de iParent. Sinon, $a instancie une classe qui n\'implmente ni iParent, ni une de ses filles.'; } ?>
332/333
V ous savez maintenant tous les comportements que peut adopter cet oprateur et tous les effets qu'il peut produire (tout est crit dans le prcdent code).
En rsum
L'oprateur instanceof permet de vrifier la nature de la classe dont l'objet test est une instance. Cet oprateur permet de vrifier qu'un certain objet est bien une instance d'une classe fille de telle classe. Cet oprateur permet de vrifier qu'un certain objet est une instance d'une classe implmentant telle interface, ou que l'une de ses classes mre l'implmente. Ce tutoriel est maintenant termin. J'espre qu'il vous aura plu et apport beaucoup de connaissances.
Merci Talus et Lpu8er concernant l'UML, christophetd pour la correction orthographique de quelques chapitres, prs513rosewood pour l'installation de Dia sous Mac OS, et tous les autres qui commentent pour m'aider ou m'encourager !
www.siteduzero.com