Gwa\Exception\gwRangeExceptionInfo

Complexity

Total Complexity

5

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	4
Bugs	3	Features	2

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	fetch()	0	14	2
A	getMaximum()	0	4	1
A	getMinimum()	0	4	1

<?php

namespace Gwa\Exception;

/**
 * An exception info container for out of range exceptions.
 */
class gwRangeExceptionInfo extends gwCoreExceptionInfo implements gwiExceptionInfo
{
    /**
     * @var int
     */
    protected $value;

    /**
     * @var int
     */
    protected $maximum;

    /**
     * @var int
     */
    protected $minimum;

    /**
     * @var string
     */
    protected $note;

    /**
     * Constructor.
     *
     * @param int    $value   the actual value that caused the exception
     * @param int    $minimum the minimum legal value
     * @param int    $maximum the maximum legal value
     * @param string $note    an optional note
     */
    public function __construct($value, $minimum, $maximum, $note = '')
    {
        $this->value = $value;
        $this->minimum = $minimum;
        $this->maximum = $maximum;
        $this->note = $note;
    }

    /**
     * @return string
     */
    public function fetch()
    {
        $output = sprintf(
            '%s MUST BE within the range of [%s to %s]',
            $this->value,
            $this->minimum,
            $this->maximum
        );
        if ($this->note) {
            $output .= ' ('.$this->note.')';
        }

        return $output;
    }

    /**
     * @return int
     */
    public function getMaximum()
    {
        return $this->maximum;
    }

    /**
     * @return int
     */
    public function getMinimum()
    {
        return $this->minimum;
    }
}