Start · Sprachen · PHP · Referenz · phpdbg_clear

phpdbg_clear

Funktion

Löscht alle aktuell gesetzten Breakpoints in der phpdbg-Debugger-Sitzung.

seit PHP 5.6.0 Kategorie: misc

Signatur

phpdbg_clear(): void

Beschreibung

phpdbg_clear() entfernt sämtliche Breakpoints, die während einer aktiven phpdbg-Debugger-Sitzung gesetzt wurden. Dies entspricht dem interaktiven phpdbg-Befehl clear und kann direkt aus PHP-Code heraus aufgerufen werden, um den Breakpoint-Zustand programmatisch zurückzusetzen.

Die Funktion ist ausschließlich innerhalb des phpdbg-SAPIs sinnvoll. In normalen Web- oder CLI-Umgebungen ohne phpdbg hat der Aufruf keine Wirkung bzw. ist die Funktion möglicherweise gar nicht verfügbar.

Typische Einsatzszenarien sind Test-Skripte oder Debug-Hilfsskripte, die in phpdbg ausgeführt werden und nach einem bestimmten Programmabschnitt alle zuvor gesetzten Haltepunkte zurücksetzen möchten, um anschließend neue Breakpoints zu definieren.

Rückgabewert

Typ
void
Beschreibung
Die Funktion gibt keinen Wert zurück.

Beispiele

Alle Breakpoints programmatisch löschen

<?php
// Breakpoint an einer bestimmten Zeile setzen (phpdbg-Umgebung vorausgesetzt)
phpdbg_break_file(__FILE__, 10);
phpdbg_break_file(__FILE__, 20);

// ... Debug-Logik ...

// Alle gesetzten Breakpoints auf einmal entfernen
phpdbg_clear();

echo "Alle Breakpoints wurden gelöscht.\n";
Alle Breakpoints wurden gelöscht.

Breakpoints zurücksetzen und neu definieren

<?php
// Erste Phase: Breakpoints für Initialisierungsbereich
phpdbg_break_function('someInitFunction');

// Phase abgeschlossen, Breakpoints löschen
phpdbg_clear();

// Zweite Phase: Neue Breakpoints für Hauptlogik setzen
phpdbg_break_function('mainLogic');

echo "Breakpoints für zweite Phase gesetzt.\n";
Breakpoints für zweite Phase gesetzt.

// Wichtig · Fallstricke

Hinweis: phpdbg_clear() steht nur zur Verfügung, wenn PHP unter dem phpdbg-SAPI ausgeführt wird. Ein Aufruf in einer regulären PHP-CLI- oder Web-Umgebung führt zu einem fatalen Fehler (Call to undefined function). Es empfiehlt sich, vor dem Aufruf mit function_exists('phpdbg_clear') zu prüfen, ob die Funktion verfügbar ist.

Die Funktion wurde zusammen mit dem phpdbg-SAPI in PHP 5.6 eingeführt. Ab PHP 8.0 ist phpdbg weiterhin Bestandteil der PHP-Distribution, kann aber je nach Build-Konfiguration fehlen.