Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / PHP

Exception::getMessage — získání zprávy výjimky

Přečti text zachycené výjimky, odliš ho od kódu a výpisu zásobníku volání a rozhodni, co zapsat do protokolu a co zobrazit uživateli.

Verze: PHP 8.3; extension availability may vary

Syntaxe

final public function getMessage(): string

$e->getMessage()

Exception::getMessage vrací zprávu objektu výjimky jako string. Jde o veřejnou instanční metodu bez argumentů. Označení final znamená, že ji podtřídy nemohou přepsat. Zápis :: označuje třídu v názvu metody; na objektu ji volej pomocí ->: $e->getMessage(). V PHP 8.3 vrátí volání na new \Exception() bez zprávy prázdný řetězec ''.

catch (\Exception $e) zachytí objekty třídy \Exception a jejích podtříd, ale ne objekty \Error. Pro obě hierarchie použij catch (\Throwable $e): společné rozhraní také poskytuje getMessage(). Běžná varování, která se nevyhazují jako objekty, tím nezachytíš. Úvodní \ odkazuje na globální název i uvnitř jmenného prostoru.

getMessage() nevrací kód ani výpis zásobníku volání; k tomu slouží getCode() a getTrace(). Neobsahuje ani zprávu předchozí výjimky. Předchozí objekt získej pomocí getPrevious() a před voláním getMessage() na tomto objektu ověř, že výsledek není null.

Nezakládej rozhodování programu na znění zprávy. Použij typ výjimky nebo kód s dokumentovaným významem. V produkčním prostředí nezobrazuj uživatelům nezpracované zprávy výjimek: mohou obsahovat cesty nebo citlivé údaje. Zobraz bezpečnou zprávu a do protokolu zapisuj jen vhodně očištěné diagnostické údaje.

Příklady

<?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";
    }
}

Výsledek

Import failed
Invalid row format

První řádek obsahuje zprávu zachycené výjimky. Druhý se vypíše jen proto, že kód získá předchozí objekt a samostatně na něm zavolá `getMessage()`.

Související lekce

  • PHP · Lekce 41 · Pokročilá · Verze: 2
  • PHP · Lekce 67 · Pokročilá · Verze: 2
  • PHP · Lekce 68 · Pokročilá · Verze: 2
  • PHP · Lekce 69 · Pokročilá · Verze: 2
  • PHP · Lekce 70 · Pokročilá · Verze: 2
  • PHP · Lekce 75 · Pokročilá · Verze: 2
  • PHP · Lekce 82 · Pokročilá · Verze: 2
  • PHP · Lekce 20 · Středně pokročilá · Verze: 3

Zdroje