Prérequis

Introduction

🤓 À la fin de cette quête, tu seras capable de :

• ✅ Comprendre le principe de namespace
• ✅ Créer des classes dans un espace de nom
• ✅ Comprendre le typage objet
• ✅ Injecter un objet dans un autre

Les namespaces

En programmation orientée objet, il arrive que différentes classes, portent le même nom, parce que le projet peut être vaste et contenir des centaines de fichiers, ou parce que tu utiliseras souvent des classes venues de bibliothèques externes (pour ne pas réinventer la roue, on télécharge souvent des briques de codes réalisées par d'autres développeurs ;-)). Dans ce cas, tu ne maîtrises pas forcément le nom des classes récupérées. Afin d'éviter tout conflit de nom, PHP met à disposition des espaces de noms ou namespaces.

Les namespaces permettent à une application d'utiliser des classes aux noms identiques au sein d'un même projet.

Le principe de namespace peut être comparé à un système d'arborescence de fichiers et de dossiers.

• Une arborescence de fichiers définit une structure physique de répertoires.
• Un namespace définit plutôt une structure logique de répertoires.

Prenons l'exemple de notre WildZoo. Cette application comporte déjà la classe Animal dans le fichier src/Animal.php ! Imagine que tu utilises une bibliothèque externe, contenant elle même une classe nommée Animal, que tu rangeras dans le sous-répertoire, src/Other/Animal.php.

🖥️ Maintenant, imaginons que l'on ait besoin d'utiliser ces deux classes dans un même fichier, mets à jour index.php en ajoutant le require de la nouvelle classe Animal.

<?php
require __DIR__ . '/../src/Animal.php';
require __DIR__ . '/../src/Other/Animal.php';

$animal = new Animal();

Actualise, tu obtiens alors cette erreur :

Au moment de l'instanciation de l'objet Animal, PHP ne sait pas quelle classe Animal utiliser, il y a un conflit de nom. Les espaces de noms vont pouvoir régler ce problème !

🖥️ Ajoute maintenant des namespaces dans les deux classes :

<?php 
namespace App;

class Animal
{
    // (...) Code de ta classe Animal
}

<?php
namespace App\Other;

class Animal
{
    // Code d'une autre classe Animal
}

L'effet de l'ajout de namespace sera de créer pour chacune de ces classes un :def[FQCN]{value="Fully Qualified Class Name"} (nom pleinement qualifié) construit comme ceci :

• App\Animal Pour la classe src/Animal.php
• App\Other\Animal Pour la classe src/Other/Animal.php

🖥️ Met maintenant index.php à jour pour permettre l'instanciation des deux classes (tu dois mettre le bon FQCN pour toutes les instanciations d'animaux) :

<?php
//index.php
require 'src/Animal.php';
require 'src/Other/Animal.php';

$lion = new App\Animal('lion', 4);
$otherAnimal = new App\Other\Animal();

Pour simplifier un peu cette écriture, nous utiliserons le mot clé use (en début de fichier) plutôt que d'appeler les classes par leur FQCN à chaque instanciation, ce qui peut-être long à écrire.

🖥️ Mets à jour le code :

<?php
//index.php
require 'src/Animal.php';
require 'src/Other/Animal.php';
use App\Animal;
use App\Other\Animal as OtherAnimal;

$animal = new Animal();
$otherAnimal = new OtherAnimal();

Le use demande d'écrire le FQCN une bonne fois pour toute (ton IDE t'aide généralement pour l'auto-complétion). Tu n'auras plus à le faire dans le reste du script, et tu appelleras ta classe avec la dernière partie du use (après le dernier antislash). Pour use App\Animal tu pourras ensuite appeler ta classe juste Animal pour le reste de ton code dans ce fichier index.php. Cependant, si on en reste là, le problème de conflit de nom réapparaît avec l'autre use App\Other\Animal ! Heureusement, il y a une solution, les alias de nom. À l'aide du mot clé as après le FQCN, tu peux donner un autre nom (pour ce script) à ta classe. PHP considère ensuite uniquement ce nouveau nom pour l'usage de la classe. Donc ici, suite au use App\Other\Animal as OtherAnimal, pour instancier cette classe tu devras faire un new OtherAnimal et non un new Animal car c'est le nom de l'alias qui prime.

Tu connais maintenant le fonctionnement et l'intérêt des namespaces. Cela te permettra d'aborder sereinement le principe d'autoload (chargement automatique des classes) que tu verras bientôt et spoiler nous épargnera d'écrire les require :D !

Un objet dans un autre

En POO, il est très fréquent de faire interagir les objets entre eux. Dans notre zoo, les animaux sont placés dans des zones. Le lion et l'éléphant vont être dans la zone "savane", le perroquet dans la zone "jungle", le poisson dans l'aquarium, etc.

🖥️ Crée la classe Area, dans le fichier src/Area.php et dans le namespace App. Ajoute le require pour le fichier Area.php dans index.php ainsi que le use adéquat.

Actualise la page dans ton navigateur. Tu dois maintenant voir une nouvelle icône en forme de carte apparaître en haut à droite. Clique dessus pour ouvrir la carte des zones de ton zoo. Pour le moment, tu n'en a pas déclaré donc la carte est vide. Arrangeons vite cela.

🖥️ Dans la classe Area, ajoute (en typant bien) :

• une propriété $name
• un constructeur pour indiquer le nom de la zone à l'instanciation d'un nouvelle Area.
• une méthode getName()

Dans index.php, instancie un objet $savana de type Area, en lui passant le nom 'savana'. Comme tu l'as fait pour les animaux, il faut aussi créer un tableau $areas dans lequel tu mettras tes objets Area, ce tableau est utilisé pour la partie l'affichage. Actualise ta page, tu vois ta nouvelle zone apparaître. Une image est choisie automatiquement depuis le dossier images/areas en fonction du nom de la zone, il en existe plusieurs de disponible (savana, aquarium, jungle...) donc n'hésite pas à en ajouter d'autres.

$savana = new Area('savana');
$areas = [$savana];

Maintenant, tu veux pouvoir ajouter les animaux à tes Area. L'idée pour organiser tout ça, va être de créer une propriété $animals, qui sera un tableau contenant des animaux (c'est-à-dire des instances de la classe Animal).

Tes objets Area contiendront donc des objets Animal ! Voici le diagramme de classe :

🖥️ Dans la classe Area, ajoute :

• une proriété $animals de type array, avec en tableau vide en valeur par défaut.
• un getter getAnimals() renvoyant un array. Un setter pour le nom n'est pas nécessaire, une zone ne va pas changer de nom.
• pour ajouter un nouvel animal, on pourrait créer un setter setAnimals() qui prendrait un tableau en paramètres. Cependant, cela serait compliqué de s'assurer que ce tableau contient uniquement des objets de type Animal. Une bonne alternative est plutôt de créer une méthode addAnimal() :

public function addAnimal(Animal $animal): void
{
    $this->animals[] = $animal;
}

Cette méthode va prendre en paramètre un objet de type Animal.

Challenge

• Fais en sorte de bien utiliser les namespaces et les use.

Ajoute au moins les zones savana et jungle à ta carte.

En utilisation addAnimal(), ajoutes-y des animaux :

• Pour la zone savane, ajoute le lion et l'éléphant.
• Pour la zone jungle, ajoute le perroquet.

Une fois qu'une zone possède des animaux, tu peux cliquer sur l'icône de cette zone sur la carte, pour revenir sur la page des animaux, mais affichant uniquement ceux de la zone en question (regarde la query string dans l'URL).

• Poste le code de ta page index.php.

Validation

• Le code de la page index possède les use pour Area et Animal
• Des objets de type Area sont instanciés pour la savane et la jungle, et les bons animaux sont mis dedans.

==$==

<?php

/***************************************/
/******** ⚠️ WORK HERE ONLY ⚠️ ***********/

require __DIR__ . '/../src/Animal.php';
require __DIR__ . '/../src/Area.php';

use App\Area;
use App\Animal;

$lion = new Animal('lion', 4);
$lion->setCarnivorous(true);
$lion->setSize(70);
$lion->setThreatenedLevel('VU');

$parrot = new Animal('parrot', 2);
$parrot->setSize(30);

$elephant = new Animal('elephant', 4);
$elephant->setThreatenedLevel('LC');

$animals = [$lion, $parrot, $elephant];

$savana = new Area('savana');
$savana->addAnimal($lion);
$savana->addAnimal($elephant);
$jungle = new Area('jungle');
$jungle->addAnimal($parrot);

$areas = [$savana, $jungle];

/***************************************/
/***************************************/


// Do not modify code below
require 'view.php';
?>