Gwa\Exception\gwCoreException

Complexity

Total Complexity

8

Size/Duplication

Total Lines	172
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes	4
Bugs	3	Features	2

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	__toString()	0	4	1
A	__set()	0	8	2
A	__get()	0	9	2
A	getInfo()	0	4	1

<?php

namespace Gwa\Exception;

/**
 * The core exception class, to be extended by all other Exceptions.
 */
class gwCoreException extends \Exception
{
    /**
     * A logic error.
     *
     * @var string
     */
    const ERR_LOGIC_ERROR = 'gwCoreException::logic_error';

    /**
     * Method does not exist on object
     * info = name of method called.
     *
     * @var string
     */
    const ERR_BAD_METHOD_CALL = 'gwCoreException::bad_method_call';

    /**
     * Argument passed to a method is invalid, and is not one of the following:
     * - invalid type
     * - out of bounds
     * - out of range.
     *
     * @var string
     */
    const ERR_INVALID_ARGUMENT = 'gwCoreException::invalid_argument';

    /**
     * Required argument is missing. Possibly within an array passed as an
     * argument.
     *
     * @var string
     */
    const ERR_MISSING_ARGUMENT = 'gwCoreException::missing_argument';

    /**
     * Argument passed to a method has the wrong type.
     *
     * @var string
     */
    const ERR_INVALID_TYPE = 'gwCoreException::invalid_type';

    /**
     * Argument passed is out of the allowed numeric range.
     *
     * @var string
     */
    const ERR_OUT_OF_RANGE = 'gwCoreException::out_of_range';

    /**
     * Argument passed is out of the allowed set of possible options
     * Could be used
     * - when an array key does not exist
     * - when an property does not exist on an object
     * - when a value is not within a specific range.
     *
     * @var string
     */
    const ERR_OUT_OF_BOUNDS = 'gwCoreException::out_of_bounds';

    /**
     * Thrown when trying to create an entry with a key that should be unique.
     * E.g. insert into database, create element in array.
     *
     * @var string
     */
    const ERR_KEY_EXISTS = 'gwCoreException::key_exists';

    /**
     * Thrown when trying to retrieve an entry with a key and no entry exists.
     * E.g. read from database, read from array.
     *
     * @var string
     */
    const ERR_KEY_NOT_EXIST = 'gwCoreException::key_not_exist';

    /**
     * Thrown by a method when caller does not have sufficient privileges.
     * E.g. database entry exists, but is blocked, inactive, unconfirmed, etc.
     *
     * @var string
     */
    const ERR_ACCESS_DENIED = 'gwCoreException::access_denied';

    /**
     * Value returned by method or function was unexpected.
     *
     * @var string
     */
    const ERR_UNEXPECTED_VALUE = 'gwCoreException::unexpected_value';

    /**
     * Container is full and someone is trying to add something to it.
     *
     * @var string
     */
    const ERR_OVERFLOW = 'gwCoreException::overflow';

    /**
     * Container is empty and someone is trying to remove something from it.
     *
     * @var string
     */
    const ERR_UNDERFLOW = 'gwCoreException::underflow';

    /**
     * @var gwCoreExceptionInfo
     */
    protected $info;

    /**
     * Constructor.
     *
     * @param string                          $message
     * @param gwCoreExceptionInfo|string|null $info
     * @param int                             $code
     * @param \Exception|null                 $previous
     */
    public function __construct($message, $info = null, $code = 0, \Exception $previous = null)
    {
        if (!is_a($info, 'gwCoreExceptionInfo')) {
            $info = new gwCoreExceptionInfo($info);

It seems like $info defined by new \Gwa\Exception\gwCoreExceptionInfo($info) on line 129 can also be of type object<Gwa\Exception\gwCoreExceptionInfo> or string; however, Gwa\Exception\gwCoreExceptionInfo::__construct() does only seem to accept object<Gwa\Exception\gwCoreException>|null, maybe add an additional type check?

        }
        $info->setException($this);

It seems like $info is not always an object, but can also be of type string|null. Maybe add an additional type check?

        $this->info = $info;

It seems like $info can also be of type string. However, the property $info is declared as type object<Gwa\Exception\gwCoreExceptionInfo>. Maybe add an additional type check?

        parent::__construct($message, $code, $previous);
    }

    /**
     * @return string representation of this Exception
     */
    public function __toString()
    {
        return __CLASS__ . " [$this->code]: $this->message | ".$this->info->fetch();
    }

    /**
     * @param string $key
     * @param string $value
     */
    public function __set($key, $value)
    {
        switch ($key) {
            case 'info':
                $this->info = $value;

It seems like $value of type string is incompatible with the declared type object<Gwa\Exception\gwCoreExceptionInfo> of property $info.

                break;
        }
    }

    /**
     * @param string $key
     *
     * @return mixed
     */
    public function __get($key)
    {
        switch ($key) {
            case 'info':
                return $this->info;
        }

        return null;
    }

    /**
     * @return gwCoreExceptionInfo
     */
    public function getInfo()
    {
        return $this->info;
    }
}