WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / PHP

Exception::getMessage — die Meldung einer Ausnahme auslesen

Lies die Meldung einer abgefangenen Ausnahme aus, unterscheide sie von Fehlercode und Stacktrace und entscheide, was ins Protokoll und was in die Benutzerantwort gehört.

Version: PHP 8.3; extension availability may vary

Syntax

final public function getMessage(): string

$e->getMessage()

Exception::getMessage gibt die Meldung eines Ausnahmeobjekts als string zurück. Die öffentliche Instanzmethode nimmt keine Argumente entgegen; final bedeutet, dass Unterklassen sie nicht überschreiben können. :: kennzeichnet die Klasse im Methodennamen. Der Aufruf erfolgt mit -> am Objekt: $e->getMessage(). Bei new \Exception() ohne Meldung liefert der Aufruf in PHP 8.3 die leere Zeichenkette ''.

catch (\Exception $e) fängt Objekte vom Typ \Exception und dessen Unterklassen ab, aber keine \Error-Objekte. Verwende für beide Hierarchien catch (\Throwable $e): Auch die gemeinsame Schnittstelle stellt getMessage() bereit. Gewöhnliche Warnungen, die nicht als Objekte geworfen werden, fängt das nicht ab. Das vorangestellte \ verweist auch innerhalb eines Namensraums auf den globalen Namen.

getMessage() liefert weder den Code noch den Stacktrace; dafür gibt es getCode() und getTrace(). Auch die Meldung der vorherigen Ausnahme ist nicht enthalten. Hole das vorherige Objekt mit getPrevious() und prüfe, ob das Ergebnis null ist, bevor du darauf getMessage() aufrufst.

Verwende den Wortlaut der Meldung nicht für Verzweigungen im Programm. Nutze stattdessen einen Ausnahmetyp oder einen Code mit dokumentierter Bedeutung. Zeige Benutzern im Produktivbetrieb keine unverarbeiteten Ausnahmemeldungen: Sie können Pfade oder vertrauliche Daten enthalten. Zeige eine unbedenkliche Meldung und protokolliere nur entsprechend bereinigte Diagnosedetails.

Beispiele

<?php

try {
    $cause = new \Exception('Invalid row format');
    throw new \Exception('Import failed', previous: $cause);
} catch (\Exception $e) {
    echo $e->getMessage(), "\n";

    $previous = $e->getPrevious();
    if ($previous !== null) {
        echo $previous->getMessage(), "\n";
    }
}

Ergebnis

Import failed
Invalid row format

Die erste Zeile enthält die Meldung der abgefangenen Ausnahme. Die zweite erscheint nur, weil der Code das vorherige Objekt abruft und darauf separat `getMessage()` aufruft.

Zugehörige Lektionen

  • PHP · Lektion 41 · Fortgeschritten · Version: 2
  • PHP · Lektion 67 · Fortgeschritten · Version: 2
  • PHP · Lektion 68 · Fortgeschritten · Version: 2
  • PHP · Lektion 69 · Fortgeschritten · Version: 2
  • PHP · Lektion 70 · Fortgeschritten · Version: 2
  • PHP · Lektion 75 · Fortgeschritten · Version: 2
  • PHP · Lektion 82 · Fortgeschritten · Version: 2
  • PHP · Lektion 20 · Mittlere Stufe · Version: 3

Quellen