phpdbg_color — Funktion · PHP-Referenz

Signatur

phpdbg_color(int $element, string $color): void

Beschreibung

phpdbg_color() ermöglicht es, die Darstellungsfarbe bestimmter Ausgabeelemente im interaktiven PHP-Debugger phpdbg anzupassen. Die Funktion ist ausschließlich im Kontext des phpdbg-SAPIs sinnvoll und hat in anderen Umgebungen (z. B. CLI, FPM, Apache) keine Wirkung.

Das erste Argument element bestimmt, welches Ausgabeelement (z. B. Eingabeaufforderung, Fehlermeldung, Hinweistext) eingefärbt werden soll. Dafür stehen vordefinierte Konstanten wie PHPDBG_COLOR_PROMPT, PHPDBG_COLOR_NOTICE und PHPDBG_COLOR_ERROR zur Verfügung.

Das zweite Argument color ist ein String, der eine ANSI-kompatible Farb- oder Formatierungsangabe enthält, z. B. "bold green" oder "red". Die genaue Syntax richtet sich nach den im phpdbg-Quellcode definierten Farbbezeichnungen.

Diese Funktion eignet sich besonders für die Konfiguration von phpdbg-Initialisierungsskripten (.phpdbginit), um die Lesbarkeit der Debugger-Ausgabe individuell anzupassen.

Parameter

Name	Typ	Default	Beschreibung
$element Pflicht	int		Das zu färbende Ausgabeelement, angegeben als eine der Konstanten `PHPDBG_COLOR_PROMPT`, `PHPDBG_COLOR_NOTICE` oder `PHPDBG_COLOR_ERROR`.
$color Pflicht	string		Die gewünschte Farbe als Zeichenkette, z. B. `"bold green"`, `"red"` oder `"none"` zum Zurücksetzen. Die Werte entsprechen den im `phpdbg`-Interpreter definierten ANSI-Farbbezeichnungen.

Rückgabewert

Typ

void

Beschreibung

Diese Funktion gibt keinen Wert zurück.

Beispiele

Farben im .phpdbginit-Skript setzen

<?php
// Dieses Skript wird typischerweise in einer .phpdbginit-Datei verwendet,
// die phpdbg beim Start automatisch einliest.

// Eingabeaufforderung in fett-grün darstellen
phpdbg_color(PHPDBG_COLOR_PROMPT, 'bold green');

// Fehlermeldungen in roter Farbe anzeigen
phpdbg_color(PHPDBG_COLOR_ERROR, 'red');

// Hinweistexte in gelb hervorheben
phpdbg_color(PHPDBG_COLOR_NOTICE, 'yellow');

Farben zurücksetzen

<?php
// Alle Farbanpassungen für die Eingabeaufforderung entfernen
phpdbg_color(PHPDBG_COLOR_PROMPT, 'none');
phpdbg_color(PHPDBG_COLOR_ERROR, 'none');
phpdbg_color(PHPDBG_COLOR_NOTICE, 'none');

// Wichtig · Fallstricke

Nur im phpdbg-SAPI verfügbar: Die Funktion und die zugehörigen Konstanten (PHPDBG_COLOR_PROMPT, PHPDBG_COLOR_NOTICE, PHPDBG_COLOR_ERROR) existieren ausschließlich, wenn PHP unter dem phpdbg-SAPI ausgeführt wird. Ein Aufruf in anderen Umgebungen führt zu einem schwerwiegenden Fehler, sofern phpdbg nicht geladen ist.

Die Dokumentation zu dieser Funktion ist offiziell sehr dünn. Für verlässliche Informationen empfiehlt sich ein Blick in den phpdbg-Quellcode.

Siehe auch

phpdbg_break_next phpdbg_exec phpdbg_prompt