phpdbg_prompt — Funktion · PHP-Referenz

Signatur

phpdbg_prompt(string $string): void

Beschreibung

phpdbg_prompt() ermöglicht es, den Eingabe-Prompt der interaktiven phpdbg-Debugging-Konsole durch eine eigene Zeichenkette zu ersetzen. Standardmäßig zeigt phpdbg einen festen Prompt an; mit dieser Funktion kann dieser angepasst werden, um z. B. den aktuellen Kontext, den Skriptnamen oder sonstige nützliche Informationen anzuzeigen.

Die Funktion ist ausschließlich innerhalb des phpdbg-SAPIs sinnvoll und hat außerhalb dieses Kontexts (z. B. in einem normalen Web- oder CLI-Skript) keine Auswirkung. Sie richtet sich an Entwickler, die phpdbg als interaktiven Debugger für PHP-Skripte nutzen und den Prompt ergonomisch anpassen möchten.

Der gesetzte Prompt bleibt für die gesamte Dauer der phpdbg-Sitzung aktiv, bis er erneut durch einen weiteren Aufruf von phpdbg_prompt() geändert wird.

Parameter

Name	Typ	Default	Beschreibung
$string Pflicht	string		Die Zeichenkette, die fortan als Befehls-Prompt in der `phpdbg`-Konsole angezeigt werden soll.

Rückgabewert

Typ

void

Beschreibung

Die Funktion gibt keinen Wert zurück.

Beispiele

Einfaches Setzen eines benutzerdefinierten Prompts

<?php
// Nur sinnvoll im phpdbg-SAPI
if (PHP_SAPI === 'phpdbg') {
    // Setzt den Prompt auf "debug> "
    phpdbg_prompt('debug> ');
}
?>

Prompt mit Skriptname und Trenner

<?php
// Nur sinnvoll im phpdbg-SAPI
if (PHP_SAPI === 'phpdbg') {
    $scriptName = basename(__FILE__);
    // Setzt den Prompt auf z. B. "[meinSkript.php] >> "
    phpdbg_prompt('[' . $scriptName . '] >> ');
}
?>

// Wichtig · Fallstricke

Hinweis: Diese Funktion ist nur im phpdbg-SAPI verfügbar. In anderen SAPIs (z. B. cli, fpm, apache) ist sie zwar definiert, hat aber keinerlei Wirkung. Es empfiehlt sich daher, vor dem Aufruf mit PHP_SAPI === 'phpdbg' zu prüfen, ob man sich im richtigen Kontext befindet.

Die Funktion ist Teil der internen phpdbg-Erweiterung und in der allgemeinen PHP-Praxis selten anzutreffen, da phpdbg selbst ein Nischenprodukt ist und zunehmend von anderen Debugging-Werkzeugen wie Xdebug abgelöst wird.

Siehe auch

phpdbg_break_next phpdbg_exec phpdbg_color