PanicLabCore\Structs\Step

Complexity

Total Complexity

9

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setCurrentIndex()	0	3	1
A	checkForOverstep()	0	7	2
A	getMaxStep()	0	3	1
A	__construct()	0	5	1
A	getStepCount()	0	3	1
A	getCurrentIndex()	0	3	1
A	increase()	0	9	2

<?php

declare(strict_types=1);

namespace PanicLabCore\Structs;

use PanicLabCore\Services\Exceptions\TooManyStepsException;
use function sprintf;

class Step
{
    /** @var int */
    private $currentIndex;

    /** @var int */
    private $stepCount;

    /** @var int */
    private $maxStep;

    public function __construct(int $currentIndex, int $stepCount, int $maxStep)
    {
        $this->currentIndex = $currentIndex;
        $this->stepCount = $stepCount;
        $this->maxStep = $maxStep;
    }

    public function getCurrentIndex(): int
    {
        return $this->currentIndex;
    }

    public function getStepCount(): int
    {
        return $this->stepCount;
    }

    public function getMaxStep(): int
    {
        return $this->maxStep;
    }

    /**
     * @throws TooManyStepsException
     */
    public function increase(): void
    {
        ++$this->stepCount;

        if ($this->stepCount === $this->maxStep) {
            throw new TooManyStepsException(sprintf('Step limit of %d reached', $this->maxStep));
        }

        ++$this->currentIndex;
    }

    public function checkForOverstep(int $totalCount): void
    {
        if ($this->currentIndex <= $totalCount - 1) {
            return;
        }

        $this->currentIndex = 0;
    }

    public function setCurrentIndex(int $currentIndex): void
    {
        $this->currentIndex = $currentIndex;
    }
}