On reprend le TD numéro 5 et on le refait en POO.

Je vais reprendre le TD numéro 5 que j'ai fait en procédural et je vais le passer en POO. Ca va me permettre de mettre en évidence essentiellement l'intérêt de l'encapsulation et de l'injection de dépendance 😃. Le TD numéro 5 est un outil pour entraîner la mémoire.

C'est un outil qui vous pose une question. Vous devez essayer de trouver une réponse et la garder en tête. Puis, vous demandez l'affichage de la réponse pour vérifier.

Demo ICI

Cet outil est composé :

D'un fichier data.php qui gère les données qui se trouvent dans un fichier. Ce fichier se nomme data.txt. Vous avez un exemple ci-dessous. Chaque ligne du fichier contient un couple question/réponse. La question et la réponse sont séparées par une virgule. Comment connaître la version du PHP qui est installée sur ma machine ?,php -v Comment lancer le serveur interne de PHP ?,php -S localhost:3000 Comment faire un phpinfo() en ligne de commande ?,php -i Comment connaître la version de Composer ?, composer -V ou bien composer --version
D'un fichier afficher.php qui gère les affichages.
D'un script principal memo.php qui fait un require des deux fichiers précédents.

Je résume ci-dessous le fonctionnement de memo.php.

On charge les données sous la forme d'un tableau qui contient des couples de questions et réponses. Chaque couple a un numéro dans un tableau à deux dimensions.
S'il n'y a pas la superglobale $_GET['numero'] d'injectée dans le script alors :
- On va tirer au sort un numéro de couple question/réponse.
- On va afficher la question. C'est là que vous devez chercher dans votre tête si vous avez la réponse.
- On prépare un champ caché, qui contient le numéro de ce couple. L'appui sur le bouton Afficher Réponse relance le script memo.php mais cette fois avec $_GET['numero'] qui est affectée avec le numéro du couple question/réponse.
S'il y a la superglobale $_GET['numero'] d'injectée dans le script alors :
- On affiche la question et sa réponse.
- Et c'est là que vous pouvez vérifier si vous aviez la bonne réponse.

<!DOCTYPE html>
<html lang="fr">

<head>
	<meta charset="UTF-8">
	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	<title>TD5 - Memo</title>
</head>
<body>
	<?php
	require "data.php";
	require "afficher.php";
	$numero = $_GET['numero'] ?? null;

// Précaution sur la valeur de $numero
	if ($numero !== null && (is_numeric($numero) !== true)) die;

// Depuis fichier data.txt on charge les Questions/Réponses
	// Regardez ce $fd qui traîne ici dans le script principal
	// Il n'a rien à faire ici. Il fait partie de la complexité de la "couche" data.php
	// L'ENCAPSULATION de la POO va nous permettre de résoudre ça !!
	$qr = getQR($fd);

// S'il n'y a pas de $numero d'injecté dans le script
	if ($numero === null) {
		// On tire au sort un numéro de couple question / réponse
		$numero = rand(0, count($qr) - 1);
		// On affiche simplement la question
		afficherQuestion($qr, $numero);
	// Sinon
	} else
		// On affiche la question et sa réponse
		afficherQuestionReponse($qr, $numero);
	?>
</body>
</html>

Comme je l'ai dit dans le tuto La POO pour quoi faire ?, procédural ou POO, l'analyse fonctionnelle ne change pas. Bien sûr, il va y avoir des différences de conception. Mais souvent, on retrouve grosso modo la même modularité.
Dans un premier temps, ce que l'on va faire, c'est mettre des classes en place dans les fichiers data.php et afficher.php. Ensuite, on construira les objets dans le script principal.
On va s'occuper en premier du fichier data.php, que l'on va renommer en Data.php, car il contient une classe. Ce que je veux, c'est encapsuler la variable $fd et faire en sorte qu'elle ne remonte pas dans le script principal 😃. Le script principal se fiche de l'endroit où l'on va chercher les données. Il ne veut rien connaître de cette complexité. Il veut faire un getQR() et récupérer ses données. C'est tout !

<?php
// Fichier Data.php
class Data {

private const MY_DATA_FILE = 'data.txt';

// Modif => On va cacher cette variable dans la classe
	// Elle sera initialisée au __construct
	private $fd;

/**
	 * @return array tableau correspondant aux donnés. Une ligne du fichier pour un élément du tableau
	 */
	// Modif => Le $fd n'est plus en argument du getQR()
	 public function getQR(): array {
		$qr = []; // ou bien array()
		$i = 0;

// Modif => Le $fd a été remplacé par un $this->fd
		while (($line = fgets($this->fd)) !== false) {
			$qr[$i]['question'] = explode(',', $line)[0];
			$qr[$i]['reponse']  = explode(',', $line)[1];
			$i++;
		}
		return $qr;
	}

// Modif => on ajoute un constructeur
	public function __construct() {
		if (file_exists(self::MY_DATA_FILE) === false)
			throw new Exception("Fichier non trouvé");

// Modif => Le $fd a été remplacé par un $this->fd
		// Ouverture du fichier => on récupèrera le $this->fd dans le premier objet construit
		// On pourrait utiliser ici un design pattern spécifique qui est le Singleton. Ce n'est pas le sujet du jour.
		if (($this->fd = fopen(self::MY_DATA_FILE, 'r')) === false)
			throw new Exception("Echec ouverture");
	}
}

A présent, on s'occupe du fichier Afficher.php. Dans ce fichier, on va se contenter de mettre une classe en place.
Je déclare les méthodes en public. Si je ne mets rien, PHP déclare par défaut les méthodes en public, mais c'est mieux de le mettre.

Maintenant, je reprends le script principal. Il va falloir que je construise les objets.
Il faut se souvenir que le new Data() va déclencher l'appel du __construct(). C'est à ce moment-là que l'on va initialiser la "couche logicielle" Data.php. Remarquez bien que, maintenant, l'initialisation est locale à la classe et encapsulée dans la classe. Cette initialisation va se faire au moment de la création de l'objet $data dans le script principal 😃.

A présent, je veux simplifier mon script principal. Le tableau $qr qui contient des données apparait plusieurs fois dans le script principal. Je voudrais cacher ces données. C'est la classe Afficher qui en a besoin. Je vais donc injecter un objet de la classe Data dans le constructeur de la classe Afficher. C'est ce que l'on appelle injecter une dépendance 😃.

Je vais supprimer le $qr = $data->getQR(); (* ligne 27 ci-dessus) et le faire descendre dans la classe Afficher.

Il faudra de ce fait retoucher tous les endroits où figure la variable $qr.

Ci-dessous la classe Afficher avec les modifications.

<?php
// Afficher.php
class Afficher {

// Modif => Le tableau qui contient les données est maintenant encapsulé dans la classe Afficher
	private array $qr;

// Modif => Il faut ajouter cette méthode "get" pour récupérer un numéro tiré au sort.
	public function getRandNumero(): int {
		return rand(0, count($this->qr) - 1);
	}

/**
	 * @param int $numero du couple question/réponse
	 * @return void 
	 */
	public function Question($numero): void {

echo "<p>Tirage question numéro => $numero<p>\n";
		// Modif => ci-dessous il a fallu remplacer les $qr par des $this->qr
		echo "<p>{$this->qr[$numero]['question']}</p>\n";
	?>
		<form action="">
			<p><input type="submit" value='Afficher Réponse'></p>
			<input name='numero' type='hidden' value='<?php echo $numero ?>'>
		</form>
	<?php
	}
	/**
	 * @param int $numero du couple question/réponse
	 * @return void 
	 */
	public function QuestionReponse($numero): void {
		echo "<p>Afficher Question/Réponse numéro => $numero</p>\n";
		// Modif => ci-dessous il a fallu remplacer les $qr par des $this->qr
		echo "<p>{$this->qr[$numero]['question']}<br>";
		echo "{$this->qr[$numero]['reponse']}</p>\n";
	?>
		<form action="">
			<input type="submit" value='Question Suivante'>
		</form>
	<?php
	}

// Remarquer que la classe Data prend la place d'un type
	// C'est normal dans la mesure où elle contient une structure de données
	public function __construct(Data $data) {

// C'est ici que l'on charge nos données
		$this->qr = $data->getQR();
	}
}

Vous pouvez constater ci-dessous que toutes les données sont encapsulées dans les objets.
On a encapsulé la gestion du fichier et de son descripteur $fd dans Data.php.
On a encapsulé le tableau de données $qr dans Afficher.php.
Il ne reste dans le script principal memo.php que la fonction essentielle de ce script, à savoir : S'il n'y a pas de numéro d'injecté, il le tire au sort et il affiche la question. S'il y a un numéro d'injecté, il affiche la question et la réponse.
L'initialisation des deux "couches logicielles" que constituent les classes se fait localement dans chaque objet au moment de sa construction. Rien ne traîne dans l'application principale pour initialiser quoi que ce soit. C'est important de le voir. Si vous avez déjà fait de grosses applications qui nécessitent la mise en place de beaucoup de ressources, alors, vous devez bien sentir l'avantage que je mets ici en évidence.
Et tout cela sans avoir mis en place le moindre mécanisme d'héritage !!

Passer d'un script procédural à un script POO

#1 Objectif du tuto

#2 On passe l'exemple ci-dessus de procédural à POO ?

#3 On injecte une dépendance