toString et debugInfo

Fait partie de la section Programmation Orientée Objet du Journey PHP de Coddy. Leçon 45 sur 91.

La méthode __toString() vous permet de définir comment un objet doit être représenté sous forme de chaîne. Elle est appelée automatiquement lorsque vous utilisez un objet dans un contexte de chaîne, par exemple avec echo ou lors d’une concaténation de chaînes.

<?php
class User {
    public function __construct(
        private string $name,
        private string $email
    ) {}
    
    public function __toString(): string {
        return $this->name . " (" . $this->email . ")";
    }
}

$user = new User("Alice", "alice@example.com");
echo $user;

Sortie :

Alice (alice@example.com)

La méthode __debugInfo() contrôle les informations qui apparaissent lorsque vous utilisez var_dump() sur un objet. Cela est utile pour masquer des données sensibles ou afficher des valeurs calculées lors du débogage :

<?php
class BankAccount {
    public function __construct(
        private string $accountNumber,
        private float $balance,
        private string $pin
    ) {}
    
    public function __debugInfo(): array {
        return [
            'accountNumber' => '****' . substr($this->accountNumber, -4),
            'balance' => $this->balance,
            'pin' => '[HIDDEN]'
        ];
    }
}

$account = new BankAccount("1234567890", 1500.00, "9876");
var_dump($account);

Sortie :

object(BankAccount)#1 (3) {
  ["accountNumber"]=>
  string(8) "****7890"
  ["balance"]=>
  float(1500)
  ["pin"]=>
  string(8) "[HIDDEN]"
}

Remarquez comment __debugInfo() renvoie un tableau de paires clé-valeur qui remplace l’affichage par défaut des propriétés. Le PIN sensible est masqué, et le numéro de compte est partiellement masqué — parfait pour un débogage sécurisé.

Défi

Facile

Construisons un système de gestion des identifiants qui illustre les deux méthodes magiques __toString() et __debugInfo(). Vous allez créer une classe qui affiche des informations compréhensibles lorsqu’elle est imprimée, tout en protégeant les données sensibles lors du débogage.

Vous allez organiser votre code sur deux fichiers :

Credential.php : créez une classe Credential qui stocke les informations de connexion de manière sécurisée. Utilisez la promotion du constructeur pour définir les propriétés privées $username (chaîne), $password (chaîne) et $lastLogin (chaîne). Implémentez deux méthodes magiques :
- __toString() : renvoie une chaîne conviviale : "User: [username] (Last login: [lastLogin])". Remarquez que le mot de passe n’est jamais exposé dans la représentation sous forme de chaîne.
- __debugInfo() : renvoie un tableau pour var_dump() qui affiche le nom d’utilisateur tel quel, masque le mot de passe en affichant uniquement "[PROTECTED]" et affiche normalement la date de dernière connexion.
main.php : incluez le fichier Credential. Vous recevrez trois entrées : un nom d’utilisateur, un mot de passe et une date de dernière connexion. Créez une instance de Credential avec ces valeurs. Commencez par faire un echo direct de l’objet d’identifiants (cela déclenche __toString()). Ensuite, sur une nouvelle ligne, utilisez var_dump() sur l’objet afin d’observer la sortie de débogage protégée.

La méthode __toString() offre un moyen clair et sûr d’afficher les identifiants sans exposer le mot de passe. La méthode __debugInfo() garantit que, même lors du débogage, les informations sensibles restent masquées : une pratique essentielle lorsque vous travaillez avec des données d’authentification.

Essayez vous-même

<?php

require_once 'Credential.php';

// Lire les entrées
$username = trim(fgets(STDIN));
$password = trim(fgets(STDIN));
$lastLogin = trim(fgets(STDIN));

// TODO: Créer une instance de Credential avec les valeurs d'entrée

// TODO: Faire un echo de l'objet credential (déclenche __toString())

// TODO: Utiliser var_dump() sur l'objet pour voir la sortie de débogage protégée

?>