RedBean PHP<\/a>.<\/p>\nJe pr\u00e9senterais dans un prochain billet l’architecture de l’information de ce projet via un diagramme de classes<\/p>\n
Suite au d\u00e9veloppement d’un premier prototype, que je dois actuellement tester et faire valider par mon p\u00e8re, j’ai h\u00e9rit\u00e9 d’un \u00e9norme tas de “code spaghetti” dont je ne suis pas tr\u00e8s fier. Cette \u00e9tape m’a pourtant permis de d\u00e9finir pr\u00e9cis\u00e9ment mes besoins et les futures orientations techniques du projet.<\/p>\n
Les futures orientations<\/h2>\n
Le code produit, ainsi que je l’ai d\u00e9j\u00e0 dit, pouvait \u00eatre alors qualifi\u00e9 de “code spaghetti”. Il violait ainsi quelques bonnes pratiques fondamentales du d\u00e9veloppement informatique, que je pr\u00e9sente dans les paragraphes suivants. Pour ma d\u00e9fense, j’ai travaill\u00e9 sur cette premi\u00e8re version avec un principe \u00e9nonc\u00e9 par un ancien Team Lead avec lequel j’ai travaill\u00e9 \u00e0 Montr\u00e9al, qui se r\u00e9sumait ainsi: “Make it work, make it clean, make it fast”. Je suis donc actuellement dans la deuxi\u00e8me \u00e9tape de ce processus, le “make it clean” !<\/p>\n
Separation Of Concerns<\/h3>\n
Ce principe \u00e0 prendre en compte lors de la r\u00e9alisation d’une architecture logicielle sugg\u00e8re de garder \u00e0 l’esprit la s\u00e9paration des fonctionnalit\u00e9s au sein d’une application en modules ne se chevauchant pas et ne cr\u00e9ant ainsi pas de redondances.<\/p>\n
Single Responsibility Principle<\/h3>\n
Le principe de responsabilit\u00e9 unique demande, en programmation orient\u00e9 objet, \u00e0 valider que chacune des classes d’une application n’impl\u00e9mente qu’une responsabilit\u00e9 et n’ex\u00e9cute des op\u00e9rations ne tombant que dans le champ de cette responsabilit\u00e9, qui doit \u00eatre proprement et enti\u00e8rement impl\u00e9ment\u00e9 au sein de la-dite classe.<\/p>\n
Le respect de ce principe dans nos d\u00e9veloppements facilite l’application du principe de Separation of concerns pr\u00e9c\u00e9demment pr\u00e9sent\u00e9.<\/p>\n
DRY: Don’t Repeat Yourself<\/h3>\n
Comme son nom l’indique, ce principe va \u00e0 l’encontre d’une habitude de facilit\u00e9 de d\u00e9veloppeur d\u00e9butant, qui est de copier-coller partout un code impl\u00e9mentant le comportement souhait\u00e9 de mani\u00e8re \u00e0 gagner en vitesse. En POO, la r\u00e9alit\u00e9 est qu’un coper-coller signifie qu’une factorisation est possible, et il vaut toujours mieux prendre le temps d’appliquer cette factorisation que de r\u00e9p\u00e9ter dans n fichiers un bout de code. en OOP, plusieurs concepts nous permettent de respecter le DRY, tels que l’impl\u00e9mentation de Helpers (classes comme m\u00e9thodes), l’h\u00e9ritage de classes, ou encore le polymorhpisme.<\/p>\n
Illustrations de ces orientations<\/h2>\n
Pour illustrer mes propos, je vais vous pr\u00e9senter un code que j’ai remis en ordre r\u00e9cemment, ainsi que la mani\u00e8re dont je l’ai fais \u00e9volu\u00e9.<\/p>\n
Le code de base<\/h3>\n
Le code suivant est celui d’un webservice impl\u00e9ment\u00e9 en PHP (appel\u00e9 par AJAX au sein d’autres pages de l’application)<\/p>\n
[code language=”php”] <?php require_once(‘Mail.php’); include_once(‘..\/..\/globals.php’); require(‘..\/..\/library\/RedBeanORM\/rb.php’); $response = array(); if($_SERVER[‘REQUEST_METHOD’] == ‘POST’) { \/\/ if form has been posted process data $data = array( ‘name’ => convertAsSafeString($_POST[‘name’]), ‘firstname’ => convertAsSafeString($_POST[‘firstname’]), ’email’ => convertAsSafeString($_POST[’email’]), ‘phone’ => convertAsSafeString($_POST[‘phone’]), ‘comment’ => convertAsSafeString($_POST[‘comment’]) ); \/\/ always return true if you save the contact data ok or false if it fails $response[‘status’] = saveContact($data) ? ‘success’ : ‘error’; $response[‘message’] = $response[‘status’] ? ‘Votre message a bien \u00e9t\u00e9 sauvegard\u00e9!’ : ‘Il y a eu un probl\u00e8me lors de la sauvegarde du message.’; header(‘Content-type: application\/json’); echo json_encode($response); exit; } function convertAsSafeString($string) { $result = null; if (isset($string)) { $result = htmlspecialchars($string); } return $result; } function saveContact($data) { $success = false; R::setup(‘mysql:host=’ . Database::HOST . ‘;dbname=’ . Database::NAME, Database::USERNAME, Database::PASSWORD); $contact = R::dispense(‘contact’); $contact->name = utf8_encode($data[‘name’]); $contact->firstname = utf8_encode($data[‘firstname’]); $contact->email = utf8_encode($data[’email’]); $contact->phone = $data[‘phone’]; $contact->comment = utf8_encode($data[‘comment’]); $id = R::store($contact); SendContactMail($contact); if ($id != null) { $success = true; } return $success; } function SendContactMail($contact) { $from = $contact->email; $to = “”; $subject = “Contact”; $body = $contact->comment; $host = “”; $username = “”; $password = “”; $headers = array(‘From’ => $from, ‘To’ => $to, ‘Subject’ => $subject); $smtp = Mail::factory(‘smtp’, array( ‘host’ => $host, ‘port’ => ’25’, ‘auth’ => true, ‘username’ => $username, ‘password’ => $password ) ); $mail = $smtp->send($to, $headers, $body); if (PEAR::isError($mail)) { echo (“<p>” . $mail->getMessage() . “<\/p>”); } else { echo (“<p>Message successfully sent<\/p>”); } } ?> [\/code]<\/p>\n
Analyse du code<\/h3>\n
Que fait ce code ? Il v\u00e9rifie que la requ\u00eate est de type POST (envoi d’un formulaire): [code language=”php”] if($_SERVER[‘REQUEST_METHOD’] == ‘POST’) [\/code] Transforme les informations re\u00e7ues en variables safe: [code language=”php”] $data = array( ‘name’ => convertAsSafeString($_POST[‘name’]), ‘firstname’ => convertAsSafeString($_POST[‘firstname’]), ’email’ => convertAsSafeString($_POST[’email’]), ‘phone’ => convertAsSafeString($_POST[‘phone’]), ‘comment’ => convertAsSafeString($_POST[‘comment’]) ); function convertAsSafeString($string) { $result = null; if (isset($string)) { $result = htmlspecialchars($string); } return $result; } [\/code] Se connecte \u00e0 une base de donn\u00e9es: [code language=”php”] R::setup(‘mysql:host=’ . Database::HOST . ‘;dbname=’ . Database::NAME, Database::USERNAME, Database::PASSWORD); [\/code] Enregistre les informations dans la base de donn\u00e9es via un objet fournis par RedBean PHP: [code language=”php”] $contact = R::dispense(‘contact’); $contact->name = utf8_encode($data[‘name’]); $contact->firstname = utf8_encode($data[‘firstname’]); $contact->email = utf8_encode($data[’email’]); $contact->phone = $data[‘phone’]; $contact->comment = utf8_encode($data[‘comment’]); $id = R::store($contact); [\/code] Envoie un mail r\u00e9capitulatif \u00e0 l’administrateur: [code language=”php”] SendContactMail($contact); function SendContactMail($contact) { $from = $contact->email; $to = “postmaster”; $subject = “Contact”; $body = $contact->comment; $host = “”; $username = “”; $password = “”; $headers = array(‘From’ => $from, ‘To’ => $to, ‘Subject’ => $subject); $smtp = Mail::factory(‘smtp’, array( ‘host’ => $host, ‘port’ => ’25’, ‘auth’ => true, ‘username’ => $username, ‘password’ => $password ) ); $mail = $smtp->send($to, $headers, $body); if (PEAR::isError($mail)) { echo (“<p>” . $mail->getMessage() . “<\/p>”); } else { echo (“<p>Message successfully sent<\/p>”); } } [\/code] Et renvoie la r\u00e9ponse en format JSON: [code language=”php”] \/\/ always return true if you save the contact data ok or false if it fails $response[‘status’] = saveContact($data) ? ‘success’ : ‘error’; $response[‘message’] = $response[‘status’] ? ‘Votre message a bien \u00e9t\u00e9 sauvegard\u00e9!’ : ‘Il y a eu un probl\u00e8me lors de la sauvegarde du message.’; header(‘Content-type: application\/json’); echo json_encode($response); exit; [\/code]<\/p>\n
Dans ce code PHP, nous voyons bien que le principe de Single Responsibility n’est pas respect\u00e9. De plus, ce squelette de code avait \u00e9t\u00e9 r\u00e9p\u00e9t\u00e9 \u00e0 outrance pour chacun des objets que mon syst\u00e8me d’administration n\u00e9cessitait. Donc le DRY n’\u00e9tait pas non plus respect\u00e9.<\/p>\n
La solution adopt\u00e9e<\/h3>\n
Ce simple morceau de code spaghetti m’a forc\u00e9 \u00e0 revoir une grande partie de ma strat\u00e9gie de sauvegarde. En effet, j’ai d\u00e9cid\u00e9 de mettre en place une architecture r\u00e9ellement orient\u00e9e objet. Pour cela, j’ai tout d’abord impl\u00e9ment\u00e9 une classe de base, que j’ai nomm\u00e9 Entity: [code language=”php”] <?php require_once __DIR__ . ‘\/..\/library\/RedBeanORM\/rb.php’; \/** * * Entity: Base class of all objects stored in the database I will use * in this project. * Mapped to database by RedBeanPHP ORM. * **\/ class Entity { protected $_id; protected $_entity; \/\/ Base Method to be used for saving to Database purpose public function SaveEntity($post, $entityName) { $success = false; R::setup(‘mysql:host=’ . Database::HOST . ‘;dbname=’ . Database::NAME, Database::USERNAME, Database::PASSWORD); $this->_entity = R::dispense($entityName); foreach($post as $key) { if (isset($_POST[$key])) { $this->_entity->setAttr($key, Utility::ConvertAsSafeString($_POST[$key])); } } $this->_id = R::store($this->_entity); if ($this->_id != null) { $success = true; } return $success; } } [\/code]<\/p>\n
Cette classe impl\u00e9mente une m\u00e9thode de sauvegarde, qui re\u00e7oit par la variable $post un tableau contenant les noms des champs des formulaires \u00e0 utiliser, et le nom de l’entit\u00e9 \u00e0 sauvegarder.<\/p>\n
J’ai ensuite impl\u00e9ment\u00e9 une classe Contact.php, h\u00e9ritant de la classe Entity, dont le code est le suivant:<\/p>\n
[code language=”php”] <?php require_once ‘Mail.php’; require_once __DIR__ . ‘\/entity.php’; \/** * * Contact: Class derived from Entity used to manipulate contact information * send through the contact form * **\/ class Contact extends Entity { public function SaveEntity($post) { $success = false; $success = parent::SaveEntity($post, ‘contact’); $this->SendContactMail(); return $success; } private function SendContactMail() { $from = $this->_entity->email; $to = “”; $subject = “Contact”; $body = $this->_entity->comment; $host = “”; $username = “postmaster”; $password = “”; $headers = array(‘From’ => $from, ‘To’ => $to, ‘Subject’ => $subject); $smtp = Mail::factory(‘smtp’, array( ‘host’ => $host, ‘port’ => ’25’, ‘auth’ => true, ‘username’ => $username, ‘password’ => $password ) ); $mail = $smtp->send($to, $headers, $body); if (PEAR::isError($mail)) { echo (“<p>” . $mail->getMessage() . “<\/p>”); } else { echo (“<p>Message successfully sent<\/p>”); } } } ?> [\/code]<\/p>\n
Cette classe Contact surcharge la m\u00e9thode de sauvegarde de l’entit\u00e9, en appelant la m\u00e9thode de la classe parente et en ajoutant seulement un appel \u00e0 une fonction private effectuant l’envoi du mail r\u00e9capitulatif.<\/p>\n
J’ai \u00e9galement impl\u00e9ment\u00e9 une classe statique nomm\u00e9e Utility poss\u00e9dant la m\u00e9thode ConvertAsSafeString() rempla\u00e7ant celle pr\u00e9alablement r\u00e9p\u00e9t\u00e9e dans tous mes webservices.<\/p>\n
[code language=”php”] <?php \/** * * Utility class used to operate methods on string to ensure * the manipulated data are safe * **\/ class Utility { \/\/ Method to convert as safe string to save in a DB public static function ConvertAsSafeString($string) { $result = null; if (isset($string)) { $result = htmlspecialchars($string); } return $result; } } ?> [\/code]<\/p>\n
La derni\u00e8re \u00e9tape \u00e9tait finalement de revenir sur le fichier save_contact.php et de remplacer le code existant par un appel \u00e0 ces diff\u00e9rentes classes, permettant de respecter les bonnes pratiques \u00e9voqu\u00e9es plus haut !<\/p>\n
[code language=”php”] <?php require_once(‘Mail.php’); include_once(‘..\/..\/globals.php’); $response = array(); if($_SERVER[‘REQUEST_METHOD’] == ‘POST’) { \/\/ if form has been posted process data \/\/Instanciates new Contact entity to be able to use the save capability of this object $post = array(‘name’, ‘firstname’, ’email’, ‘phone’, ‘comment’); $contact = new Contact(); \/\/ always return true if you save the contact data ok or false if it fails $response[‘status’] = $contact->SaveEntity($post) ? ‘success’ : ‘error’; $response[‘message’] = $response[‘status’] ? ‘Votre message a bien \u00e9t\u00e9 sauvegard\u00e9!’ : ‘Il y a eu un probl\u00e8me lors de la sauvegarde du message.’; header(‘Content-type: application\/json’); echo json_encode($response); exit; } ?> [\/code]<\/p>\n
Comme vous pouvez le voir, un code absolument spaghetti a finalement \u00e9t\u00e9 remplac\u00e9 par un code clair, dont l’action principale est d’instancier un objet de type Contact, et de le sauvegarder en base de donn\u00e9es \u00e0 partir des informations envoy\u00e9es par le formulaire.<\/p>\n
<\/p>\n
Et maintenant ?<\/h2>\n
L’impl\u00e9mentation de ce code, ainsi que d’autres fonctions alambiqu\u00e9es que j’\u00e9voquerais dans de futurs billets (dont la mise en place d’un autoloading) m’ont motiv\u00e9es \u00e0 imaginer l’impl\u00e9mentation de mon propre framework PHP exp\u00e9rimental. Non dans une id\u00e9e de c\u00e9l\u00e9brit\u00e9 ni de contribution exceptionnelle au monde de l’open-source, mais dans l’optique de continuer \u00e0 “diver in” le fonctionnement de PHP et les possibilit\u00e9s qu’offrent ces facettes orient\u00e9 objet.<\/p>\n
Que pensez-vous de mes avanc\u00e9es, des concepts que je tente d’appliquer et de ma mani\u00e8re de pr\u00e9senter les choses ?<\/p>\n","protected":false},"excerpt":{"rendered":"
Au (re)lancement de ce site, j’avais annonc\u00e9 que je ne parlerais pas de technique sur cet espace… Malheureusement, \u00e9tant passionn\u00e9 par le d\u00e9veloppement WEB et \u00e9tant actuellement en p\u00e9riode de forte productivit\u00e9 sur des projets personnels motivants, l’envie m’a repris de d\u00e9tailler un peu mes projets et le travail associ\u00e9 ! Alors, voici un premier […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_coopedia_published":false},"categories":[25],"tags":[18,20,21,17,19,16],"_links":{"self":[{"href":"https:\/\/www.balessan.me\/api\/wp\/v2\/posts\/141"}],"collection":[{"href":"https:\/\/www.balessan.me\/api\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.balessan.me\/api\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.balessan.me\/api\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.balessan.me\/api\/wp\/v2\/comments?post=141"}],"version-history":[{"count":9,"href":"https:\/\/www.balessan.me\/api\/wp\/v2\/posts\/141\/revisions"}],"predecessor-version":[{"id":339,"href":"https:\/\/www.balessan.me\/api\/wp\/v2\/posts\/141\/revisions\/339"}],"wp:attachment":[{"href":"https:\/\/www.balessan.me\/api\/wp\/v2\/media?parent=141"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.balessan.me\/api\/wp\/v2\/categories?post=141"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.balessan.me\/api\/wp\/v2\/tags?post=141"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}