Exceptions.php

<?php

/*
 * This file is part of the Koded package.
 *
 * (c) Mihail Binev <mihail@kodeart.com>
 *
 * Please view the LICENSE distributed with this source code
 * for the full copyright and license information.
 */

namespace Koded\Exceptions;

use Koded\Stdlib\{Data, Serializer};
use RuntimeException;
use Throwable;
use function strtr;

class KodedException extends RuntimeException
{
    /**
     * @var array A map of exception code => message entries
     */
    protected array $messages = [
        Data::E_PHP_EXCEPTION => '[Exception] :message',
    ];

    /**
     * KodedException constructor.
     *
     * @param int            $code      As defined in the child classes
     * @param array          $arguments [optional] If ['message' => ''] exists in $arguments,
     *                                  this will be the error message, meaning the messages
     *                                  defined by $code in the child classes are ignored
     * @param Throwable|null $previous  [optional] The previous throwable used for the exception chaining
     */
    public function __construct(int $code, array $arguments = [], ?Throwable $previous = null)
    {
        $message = $arguments['message'] ?? $this->messages[$code] ?? $this->message;
        parent::__construct(strtr($message, $arguments), $code, $previous);
    }

    public static function generic(string $message, ?Throwable $previous = null): static
    {
        return new static(Data::E_PHP_EXCEPTION, [':message' => $message], $previous);
    }

    public static function from(Throwable $exception): static
    {
        return new static($exception->getCode(), ['message' => $exception->getMessage()], $exception);
    }
}


class ReadOnlyException extends KodedException
{
    protected array $messages = [
        Data::E_CLONING_DISALLOWED => 'Cloning the :class instance is not allowed',
        Data::E_READONLY_INSTANCE  => 'Cannot set :index. :class instance is read-only',
    ];

    public static function forInstance(string $index, string $class): static
    {
        return new static(Data::E_READONLY_INSTANCE, [':index' => $index, ':class' => $class]);
    }

    public static function forCloning(string $class): static
    {
        return new static(Data::E_CLONING_DISALLOWED, [':class' => $class]);
    }
}


class SerializerException extends KodedException
{
    protected array $messages = [
        Serializer::E_INVALID_SERIALIZER => 'Failed to create a serializer for ":name"',
        Serializer::E_MISSING_MODULE     => '[Dependency error] ":module" module is not installed on this machine',
    ];

    public static function forMissingModule(string $module): static
    {
        return new static(Serializer::E_MISSING_MODULE, [':module' => $module]);
    }

    public static function forCreateSerializer(string $name): static
    {
        return new static(Serializer::E_INVALID_SERIALIZER, [':name' => $name]);
    }
}