OpenConext\Value\Exception\IndexOutOfBoundsException

Complexity

Total Complexity

5

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	tooLow()	0	10	1
A	tooHigh()	0	10	1
A	getInvalidIndex()	0	4	1
A	getMinimumIndex()	0	4	1
A	getMaximumIndex()	0	4	1

<?php

namespace OpenConext\Value\Exception;

use OutOfBoundsException;

final class IndexOutOfBoundsException extends OutOfBoundsException implements OpenConextValueException
{
    /**
     * @var int
     */
    private $invalidIndex;

    /**
     * @var int|null
     */
    private $minimumIndex;

    /**
     * @var int|null
     */
    private $maximumIndex;

    /**
     * @param int $invalidIndex
     * @param int $minimumIndex
     * @return IndexOutOfBoundsException
     */
    public static function tooLow($invalidIndex, $minimumIndex)
    {
        $message = sprintf('Index "%d" is lower than the minimum index "%d"', $invalidIndex, $minimumIndex);

        $exception = new self($message);
        $exception->invalidIndex = $invalidIndex;
        $exception->minimumIndex = $minimumIndex;

        return $exception;
    }

    /**
     * @param int $invalidIndex
     * @param int $maximumIndex
     * @return IndexOutOfBoundsException
     */
    public static function tooHigh($invalidIndex, $maximumIndex)
    {
        $message = sprintf('Index "%d" is higher than the maximum index "%d"', $invalidIndex, $maximumIndex);

        $exception = new self($message);
        $exception->invalidIndex = $invalidIndex;
        $exception->maximumIndex = $maximumIndex;

        return $exception;
    }

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

    /**
     * @return int|null
     */
    public function getMinimumIndex()
    {
        return $this->minimumIndex;
    }

    /**
     * @return int|null
     */
    public function getMaximumIndex()
    {
        return $this->maximumIndex;
    }
}