הצגת שגיאות ב-PHP: display_errors ו-E_ALL

כדי להציג שגיאות PHP, שימו את השורות האלה בראש הסקריפט: ini_set('display_errors', '1'); ו-error_reporting(E_ALL);. הראשונה גורמת ל-PHP להדפיס הודעות שגיאה, והשנייה גורמת לה לדווח על כל סוג של שגיאה, כולל אזהרות והודעות deprecation.

<?php
ini_set('display_errors', '1');
ini_set('display_startup_errors', '1');
error_reporting(E_ALL);

כשזה במקום, טעות כמו קריאת משתנה שלא הוגדר מעולם מדפיסה הודעה עם הקובץ ומספר השורה במקום להיכשל בשקט:

Warning: Undefined variable $total in /home/index.php on line 7

error_reporting() שנקראת בלי ארגומנט מחזירה את ההגדרה הנוכחית כמספר. לחצו על Run כדי לקבוע רמה ולפענח אותה בחזרה לשמות:

<?php
error_reporting(E_ALL & ~E_DEPRECATED);
$level = error_reporting();

echo "Current level: $level (E_ALL is " . E_ALL . ")\n";

foreach (get_defined_constants(true)['Core'] as $name => $value) {
    if (str_starts_with($name, 'E_') && $name !== 'E_ALL') {
        echo str_pad($name, 20), ($level & $value) ? "reported" : "off", "\n";
    }
}

כל סוג שגיאה הוא ביט אחד, ולכן E_ALL & ~E_DEPRECATED פירושו "הכול חוץ מ-deprecations". שנו את השורה הראשונה ל-error_reporting(E_ERROR | E_WARNING); והריצו שוב.

הצגת שגיאות ב-php.ini

הגדרה בתוך הסקריפט חלה רק אחרי שהסקריפט מתחיל לרוץ. כדי להציג שגיאות בכל סקריפט, כולל שגיאות תחביר, שנו את php.ini (מצאו אותו עם php --ini):

; Development
display_errors = On
display_startup_errors = On
error_reporting = E_ALL

הפעילו מחדש את Apache או את PHP-FPM אחרי העריכה. השרת המובנה php -S ושורת הפקודה קוראים את הקובץ בכל הפעלה. באחסון משותף בלי גישה ל-php.ini, Apache עם mod_php מקבל גם שורות ב-.htaccess:

php_flag display_errors on
php_value error_reporting -1

-1 מדליק את כל הביטים, וזה אותו דבר כמו E_ALL.

רמות השגיאה

PHP 8.0 הפכה הרבה אזהרות ישנות לחריגות: חלוקה באפס עם / והעברת טיפוס שגוי לפונקציה מובנית זורקות עכשיו תת מחלקה של Error, בדיוק כמו קריאה לפונקציה לא מוגדרת מאז PHP 7. אפשר לתפוס את שלושתן:

<?php
$attempts = [
    fn() => 10 / 0,
    fn() => strlen([]),
    fn() => undefinedFunction(),
];

foreach ($attempts as $attempt) {
    try {
        $attempt();
    } catch (Throwable $e) {
        echo get_class($e), ": ", $e->getMessage(), "\n";
    }
}

חריגות מוסברות בtry ו-catch. אזהרות, notices ו-deprecations עדיין עוברות דרך מערכת דיווח השגיאות שמתוארת כאן.

רישום שגיאות ללוג במקום להציג אותן

באתר חי, מבקרים לעולם לא צריכים לראות הודעות שגיאה: הן חושפות נתיבים, SQL וקוד. כתבו אותן לקובץ לוג במקום:

; Production
display_errors = Off
log_errors = On
error_log = /var/log/php/app-errors.log
error_reporting = E_ALL

השאירו error_reporting = E_ALL בייצור. הורדת הרמה לא גורמת לשגיאות להיעלם, היא רק מונעת מכם לשמוע עליהן. ההודעות שלכם יכולות להגיע לאותו לוג עם error_log():

<?php
error_log("Payment failed for order 1042");

אחר כך עקבו אחרי הקובץ בזמן הבדיקות: tail -f /var/log/php/app-errors.log.

הפיכת אזהרות לחריגות עם set_error_handler

set_error_handler מחליפה את הטיפול הרגיל של PHP באזהרות, notices ו-deprecations בפונקציה משלכם. דפוס נפוץ ממיר כל אחת מהן ל-ErrorException, כך שמפתח מערך שנשכח עוצר את הקוד כמו כל חריגה אחרת ואפשר לתפוס אותו:

<?php
set_error_handler(function (int $severity, string $message, string $file, int $line): bool {
    throw new ErrorException($message, 0, $severity, $file, $line);
});

$prices = ['bread' => 4.5, 'milk' => 1.2];

try {
    echo "Bread costs {$prices['bread']}\n";
    echo "Cheese costs {$prices['cheese']}\n";
} catch (ErrorException $e) {
    echo "Caught: ", $e->getMessage(), " on line ", $e->getLine(), "\n";
}

restore_error_handler();

ה-handler מקבל את רמת השגיאה כארגומנט הראשון, כך שהוא יכול לטפל ברמות שונות בצורה שונה. הזה רק רושם deprecations ללוג והופך את כל השאר לחריגה:

<?php
set_error_handler(function (int $severity, string $message): bool {
    if ($severity === E_DEPRECATED || $severity === E_USER_DEPRECATED) {
        echo "[log] deprecated: $message\n";
        return true; // handled, PHP does nothing more
    }
    throw new ErrorException($message, 0, $severity);
});

trigger_error("oldFunction() is deprecated, use newFunction()", E_USER_DEPRECATED);

try {
    trigger_error("Config value 'timeout' is missing", E_USER_WARNING);
} catch (ErrorException $e) {
    echo "Exception: ", $e->getMessage(), "\n";
}

שגיאות פטאליות ושגיאות תחביר אף פעם לא מגיעות ל-handler, כי הסקריפט לא יכול להמשיך אחריהן. כדי לרשום אותן, רשמו פונקציית shutdown שקוראת את error_get_last().

קריאת השגיאה האחרונה עם error_get_last

חלק מהפונקציות מחזירות false ומדווחות על הסיבה רק כאזהרה, למשל file_get_contents על קובץ חסר. error_get_last() מחזירה את האזהרה הזו כמערך, וזה שימושי כשרוצים להציג הודעה משלכם:

<?php
$content = @file_get_contents('missing-config.json');

if ($content === false) {
    $error = error_get_last();
    echo "Could not read the file.\n";
    echo "Type: ", $error['type'] === E_WARNING ? 'E_WARNING' : $error['type'], "\n";
    echo "Message: ", $error['message'], "\n";
}

האופרטור @ לפני הקריאה משתיק את ההודעה עבור הביטוי הזה בלבד. השתמשו בו במשורה ורק כשאתם בודקים את התוצאה מיד אחר כך, כמו כאן; @ לבדו רק מסתיר באגים.

טעות נפוצה: הצגת השגיאות פעילה, אבל הדף עדיין ריק

אם הוספתם ini_set('display_errors', '1') ועדיין רואים דף לבן, השגיאה היא כנראה שגיאת תחביר. PHP מנתחת את כל הקובץ לפני שהיא מריצה את השורה הראשונה, כך ש-; או } חסרים עוצרים הכול לפני ש-ini_set רצה. בדקו את הקובץ מהטרמינל, שתמיד מדפיס את ההודעה:

php -l index.php

Errors parsing index.php
PHP Parse error:  syntax error, unexpected token "," in index.php on line 2

מספר השורה מצביע על המקום שבו PHP הרימה ידיים, ולעיתים קרובות זו השורה שאחרי הטעות האמיתית. תקנו, הריצו שוב php -l עד שיופיע No syntax errors detected, ואז טענו מחדש את הדף.