Methode __debugInfo

Die Methode __debugInfo wird aufgerufen, wenn Informationen über ein Objekt durch die Funktionen var_dump und print_r ausgegeben werden. Sie muss ein Array mit Eigenschaften zurückgeben, die angezeigt werden sollen. Dies erlaubt es, vertrauliche Daten zu verbergen oder zusätzliche Debug-Informationen hinzuzufügen.

Syntax

phppublic function __debugInfo(): array

Beispiel

Vertrauliche Daten beim Dump eines Objekts verbergen:

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

Ergebnis der Codeausführung:

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

Beispiel

Zusätzliche Debug-Informationen hinzufügen:

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

Ergebnis der Codeausführung:

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

Beispiel

Eigenschaften für die Anzeige filtern:

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

Ergebnis der Codeausführung:

phpConfig Object (
  [cacheEnabled] => 1
)

Siehe auch