Méthode __debugInfo

La méthode __debugInfo est appelée lors de l'affichage des informations sur un objet par les fonctions var_dump et print_r. Elle doit retourner un tableau avec les propriétés à afficher. Cela permet de masquer des données confidentielles ou d'ajouter des informations de débogage supplémentaires.

Syntaxe

phppublic function __debugInfo(): array

Exemple

Masquage des données confidentielles lors du dump d'un objet :

php<?php
  class User {
    private $password;
    public $name;
    
    public function __construct($name, $password) {
      $this->name = $name;
      $this->password = $password;
    }
    
    public function __debugInfo() {
      return [
        'name' => $this->name,
        'password' => '******'
      ];
    }
  }
  
  $user = new User('John', 'secret123');
  var_dump($user);
?>

Résultat de l'exécution du code :

phpobject(User)#1 (2) {
  ["name"]=> string(4) "John"
  ["password"]=> string(6) "******"
}

Exemple

Ajout d'informations de débogage supplémentaires :

php<?php
  class Product {
    public $id;
    public $price;
    
    public function __construct($id, $price) {
      $this->id = $id;
      $this->price = $price;
    }
    
    public function __debugInfo() {
      return [
        'id' => $this->id,
        'price' => $this->price,
        'price_with_tax' => $this->price * 1.2
      ];
    }
  }
  
  $product = new Product(101, 100);
  var_dump($product);
?>

Résultat de l'exécution du code :

phpobject(Product)#1 (3) {
  ["id"]=> int(101)
  ["price"]=> int(100)
  ["price_with_tax"]=> float(120)
}

Exemple

Filtrage des propriétés à afficher :

php<?php
  class Config {
    private $dbHost = 'localhost';
    private $dbUser = 'admin';
    private $cacheEnabled = true;
    
    public function __debugInfo() {
      return [
        'cacheEnabled' => $this->cacheEnabled
      ];
    }
  }
  
  $config = new Config();
  print_r($config);
?>

Résultat de l'exécution du code :

phpConfig Object (
  [cacheEnabled] => 1
)

Voir aussi