Error.php

<?php
declare(strict_types=1);

/*
 * This file is part of the QuidPHP package <https://quidphp.com>
 * Author: Pierre-Philippe Emond <emondpph@gmail.com>
 * License: https://github.com/quidphp/base/blob/master/LICENSE
 */

namespace Quid\Base;

// error
// class with methods a layer over the native PHP error functions and handler
final class Error extends Root
{
    // config
    protected static array $config = [];


    // setHandler
    // lie une callable comme gestionnaire d'erreur
    // si la valeur passé est null, le handler est remis à son état initial
    final public static function setHandler(?callable $value=null,int $type=E_ALL | E_STRICT):void
    {
        set_error_handler($value,$type);
    }


    // restoreHandler
    // remet le handler à ce qu'il était avant le dernière appel à set
    final public static function restoreHandler():bool
    {
        return restore_error_handler();
    }


    // last
    // retourne les informations sur la dernière erreur
    final public static function last():?array
    {
        return error_get_last();
    }


    // clearLast
    // efface les informations sur la dernière erreur
    final public static function clearLast():void
    {
        error_clear_last();
    }


    // log
    // log une erreur à l'endroit défini dans error_log
    final public static function log($message):bool
    {
        return error_log(self::logPrepareMessage($message),0);
    }


    // logEmail
    // log une erreur et envoie par email
    final public static function logEmail($message,string $email,string $headers=''):bool
    {
        $return = false;

        if(Validate::isEmail($email))
        $return = error_log(self::logPrepareMessage($message),1,$email,$headers);

        return $return;
    }


    // logFile
    // log une erreur dans un autre fichier que celui par défaut
    // accepte des chemins (pas besoin d'exister) ou des resources
    final public static function logFile($message,$path):bool
    {
        $return = false;

        if(Res::is($path))
        $path = Res::uri($path);

        if(Finder::isWritableOrCreatable($path))
        $return = error_log(self::logPrepareMessage($message),3,$path);

        return $return;
    }


    // logPrepareMessage
    // prépare le message en fonction de la fonction error_log
    final public static function logPrepareMessage($value):string
    {
        $return = '';

        if(is_scalar($value))
        $return = (string) $value;

        elseif(is_array($value))
        {
            foreach ($value as $v)
            {
                if(is_scalar($v))
                {
                    $return .= (strlen($return))? ' ':'';
                    $return .= (string) $v;
                }
            }
        }

        return $return;
    }


    // trigger
    // génère une erreur, le type est par défaut E_USER_ERROR
    // aucune erreur de générer si le tableau est vide ou si le message final n'est pas string
    final public static function trigger($value,int $type=E_USER_ERROR):bool
    {
        $return = false;

        if(is_array($value) && !empty($value))
        $value = Arr::implodeTrimClean(' -> ',$value);

        if(is_string($value))
        $return = trigger_error($value,$type);

        return $return;
    }


    // triggers
    // tente de générer des erreurs à partir de différentes valeurs
    // aucune erreur de générer si le tableau est vide ou si le message final n'est pas string
    final public static function triggers(...$values):bool
    {
        return Arr::some($values,fn($value) => self::trigger($value));
    }


    // reporting
    // retourne le niveau actuel de error reporting
    final public static function reporting():int
    {
        return error_reporting();
    }


    // getCodes
    // retourne le tableau de codes, mergé avec celui de lang au besoin
    final public static function getCodes(?string $lang=null):array
    {
        return Arr::plus(Lang\En::getConfig('error/code'),Lang::errorCode(null,$lang));
    }


    // code
    // cette fonctionne retourne le nom associé au code erreur de PHP
    final public static function code(int $code,?string $lang=null):?string
    {
        $return = null;
        $codes = self::getCodes($lang);

        if(array_key_exists($code,$codes))
        $return = $codes[$code];

        return $return;
    }


    // init
    // initialise la prise en charge des erreurs
    final public static function init():void
    {
        Uri::setNotFound([self::class,'trigger']);
        File::setNotFound([self::class,'trigger']);
        Obj::setCastError([self::class,'trigger']);
    }
}
?>