DAL\Exceptions\DatabaseException

Complexity

Total Complexity

5

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	addIgnoredException()	0	4	1
A	getIgnoredExceptions()	0	4	1
A	__toString()	0	13	3

<?php
namespace DAL\Exceptions;

use \Exception;
use \RuntimeException;

class DatabaseException extends RuntimeException
{

    /**
     * @var Exception[]
     */
    private $ignored = [];

    /**
     * Adds an exception that was most likely ignored to reattempt execution.
     *
     * @param Exception $value The exception that was ignored.
     * @return void
     */
    public function addIgnoredException(Exception $value)
    {
        $this->ignored[] = $value;
    }

    /**
     * Returns an array of all of the ignored exceptions.
     *
     * @return Exception[] A list of all of the ignored Exception objects.
     */
    public function getIgnoredExceptions()
    {
        return $this->ignored;
    }

    /**
     * Returns the string reprensentation of this exception.
     *
     * The returned string may include...
     *  1. The class name.
     *  2. Message.
     *  3. The previous exception with __toString called on it, if it exists.
     *  4. All of the ignored exceptions with __toString called on each of them.
     *
     * @return string
     */
    public function __toString()
    {
        $info     = get_class() . ' - ' . $this->getMessage();
        $previous = $this->getPrevious();
        if (null !== $previous) {
            $info .= ' - Previous Exception: ' . (string) $this->getPrevious();
        }
        foreach ($this->ignored as $exception) {
            $info .= "\nIgnored Exception: " . (string) $exception;
        }

        return $info;
    }
}