CryptoManana\Core\Abstractions\ErrorHandling\AbstractException

Complexity

Total Complexity

10

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setCode()	0	5	3
A	setLine()	0	5	3
A	setMessage()	0	7	2
A	setFile()	0	7	2

<?php

/**
 * Abstraction for all framework exceptions.
 */

namespace CryptoManana\Core\Abstractions\ErrorHandling;

use CryptoManana\Core\Interfaces\ErrorHandling\EditableExceptionInterface as EditableProperties;
use Exception as PhpException;

/**
 * Class AbstractException - Abstraction for all framework exceptions.
 *
 * @package CryptoManana\Core\Abstractions\ErrorHandling
 */
abstract class AbstractException extends PhpException implements EditableProperties
{
    /**
     * The default framework internal error code.
     */
    const INTERNAL_CODE = 0;

    /**
     * Get the default framework error code for this exception instance.
     *
     * @return int The exception's error code.
     */
    abstract public function getFrameworkErrorCode();

    /**
     * Change the exception's error message via fluent interface call.
     *
     * @param string|mixed $message Set a different error message.
     *
     * @return $this The exception object.
     */
    public function setMessage($message)
    {
        if (is_string($message)) {
            $this->message = $message;
        }

        return $this;
    }

    /**
     * Change the exception's error code via fluent interface call.
     *
     * @param int $code Set a different exception error code.
     *
     * @return $this The exception object.
     */
    public function setCode($code)
    {
        $this->code = is_int($code) && $code >= 0 ? $code : $this->code;

        return $this;
    }

    /**
     * Change the file location where the exception occurred via fluent interface call.
     *
     * @param string|mixed $file Set a different file path for the exception.
     *
     * @return $this The exception object.
     */
    public function setFile($file)
    {
        if (is_string($file)) {
            $this->file = $file;
        }

        return $this;
    }

    /**
     * Change the file location where the exception occurred via fluent interface call.
     *
     * @param int $line Set a different file line for the exception.
     *
     * @return $this The exception object.
     */
    public function setLine($line)
    {
        $this->line = is_int($line) && $line >= 1 ? $line : $this->line;

        return $this;
    }
}