CKTIS / PHP
Exception::getMessage — odczytywanie komunikatu wyjątku
Odczytaj tekst komunikatu z przechwyconego wyjątku, odróżnij go od kodu i śladu stosu oraz zdecyduj, co zapisać w logach, a co pokazać użytkownikowi.
Wersja: PHP 8.3; extension availability may vary
Składnia
final public function getMessage(): string
$e->getMessage()Exception::getMessage zwraca komunikat danego obiektu wyjątku jako string. Jest to publiczna metoda instancji: nie przyjmuje argumentów, a final oznacza, że podklasy nie mogą jej przesłonić. Zapis :: wskazuje klasę w nazwie metody; w kodzie wywołaj ją na obiekcie: $e->getMessage(). W PHP 8.3 new \Exception() bez komunikatu zwraca po tym wywołaniu pusty ciąg ''.
catch (\Exception $e) przechwytuje obiekty \Exception i jej podklas, ale nie obiekty \Error. Jeśli chcesz obsłużyć obie hierarchie, użyj catch (\Throwable $e): wspólny interfejs również udostępnia getMessage(). Nie przechwytuje to zwykłych ostrzeżeń, które nie zostały rzucone jako obiekty. Początkowy \ wskazuje nazwę globalną także wewnątrz przestrzeni nazw.
getMessage() nie zwraca kodu ani śladu stosu; do tego służą odpowiednio getCode() i getTrace(). Metoda nie dołącza też komunikatu poprzedniego wyjątku. Odczytaj poprzedni obiekt przez getPrevious() i przed wywołaniem na nim getMessage() sprawdź, czy wynik nie jest równy null.
Nie opieraj logiki programu na porównywaniu treści komunikatu. Użyj typu wyjątku albo kodu o udokumentowanym znaczeniu. W środowisku produkcyjnym nie pokazuj użytkownikom surowych komunikatów: mogą zawierać ścieżki lub poufne dane. Pokaż bezpieczny komunikat i zapisuj w logach tylko odpowiednio oczyszczone informacje diagnostyczne.
Przykłady
<?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";
}
}Wynik
Import failed Invalid row format
Pierwszy wiersz to komunikat przechwyconego wyjątku. Drugi pojawia się dopiero po odczytaniu poprzedniego obiektu i osobnym wywołaniu `getMessage()`.
Powiązane lekcje
- PHP · Lekcja 41 · Zaawansowany · Wersja: 2
- PHP · Lekcja 67 · Zaawansowany · Wersja: 2
- PHP · Lekcja 68 · Zaawansowany · Wersja: 2
- PHP · Lekcja 69 · Zaawansowany · Wersja: 2
- PHP · Lekcja 70 · Zaawansowany · Wersja: 2
- PHP · Lekcja 75 · Zaawansowany · Wersja: 2
- PHP · Lekcja 82 · Zaawansowany · Wersja: 2
- PHP · Lekcja 20 · Średniozaawansowany · Wersja: 3