TeamSpeak3Exception.php

Go to the documentation of this file.

<?php
 
namespace PlanetTeamSpeak\TeamSpeak3Framework\Exception;
 
use Exception;
use PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal;
use PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper;

class TeamSpeak3Exception extends Exception
{
    protected int $raw_code = 0x00;

    protected StringHelper|string|null $raw_mesg = null;

    protected static array $messages = [];

    public function __construct(string $mesg, int $code = 0x00)
    {
        parent::__construct($mesg, $code);
 
        $this->raw_code = $code;
        $this->raw_mesg = $mesg;
 
        if (array_key_exists($code, self::$messages)) {
            $this->message = $this->prepareCustomMessage(self::$messages[$code]);
        }
 
        Signal::getInstance()->emit("errorException", $this);
    }

    protected function prepareCustomMessage(StringHelper $mesg): string
    {
        $args = [
            "code" => $this->getCode(),
            "mesg" => $this->getMessage(),
            "line" => $this->getLine(),
            "file" => $this->getFile(),
        ];
 
        return $mesg->arg($args)->toString();
    }

    public static function registerCustomMessage(int $code, string $mesg): void
    {
        if (array_key_exists($code, self::$messages)) {
            throw new self("custom message for code 0x" . strtoupper(dechex($code)) . " is already registered");
        }
 
        self::$messages[$code] = new StringHelper($mesg);
    }

    public static function unregisterCustomMessage(int $code): void
    {
        if (!array_key_exists($code, self::$messages)) {
            throw new self("custom message for code 0x" . strtoupper(dechex($code)) . " is not registered");
        }
 
        unset(self::$messages[$code]);
    }

    public function getRawCode(): int
    {
        return $this->raw_code;
    }

    public function getRawMessage(): string|StringHelper|null
    {
        return $this->raw_mesg;
    }

    public function getSender(): string
    {
        $trace = $this->getTrace();
 
        return (isset($trace[0]["class"])) ? $trace[0]["class"] : "{main}";
    }
}