Metodo __debugInfo

Il metodo __debugInfo viene chiamato quando le funzioni var_dump e print_r visualizzano informazioni su un oggetto. Deve restituire un array con le proprietà da visualizzare. Questo permette di nascondere dati confidenziali o aggiungere ulteriori informazioni di debug.

Sintassi

phppublic function __debugInfo(): array

Esempio

Nascondere dati confidenziali quando si fa il dump di un oggetto:

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);
?>

Risultato dell'esecuzione del codice:

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

Esempio

Aggiungere ulteriori informazioni di debug:

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);
?>

Risultato dell'esecuzione del codice:

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

Esempio

Filtrare le proprietà da visualizzare:

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);
?>

Risultato dell'esecuzione del codice:

phpConfig Object (
  [cacheEnabled] => 1
)

Vedi anche

  • la funzione var_dump,
    che visualizza informazioni su una variabile
  • la funzione print_r,
    che visualizza informazioni leggibili su una variabile