RateLimit\Status

Complexity

Total Complexity

7

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

90%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	from()	0	4	1
A	getIdentifier()	0	4	1
A	limitExceeded()	0	4	1
A	getLimit()	0	4	1
A	getRemainingAttempts()	0	4	1
A	getResetAt()	0	4	1

<?php

declare(strict_types=1);

namespace RateLimit;

use DateTimeImmutable;

class Status
{
    /** @var string */
    protected $identifier;

    /** @var bool */
    protected $success;

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

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

    /** @var DateTimeImmutable */
    protected $resetAt;

    final protected function __construct(string $identifier, bool $success, int $limit, int $remainingAttempts, DateTimeImmutable $resetAt)
    {
        $this->identifier = $identifier;
        $this->success = $success;
        $this->limit = $limit;
        $this->remainingAttempts = $remainingAttempts;
        $this->resetAt = $resetAt;
    }

    public static function from(string $identifier, int $current, int $limit, DateTimeImmutable $resetAt)
    {
        return new static($identifier, $current <= $limit, $limit, max(0, $limit - $current), $resetAt);
    }

    public function getIdentifier(): string
    {
        return $this->identifier;
    }

    public function limitExceeded(): bool
    {
        return !$this->success;
    }

    public function getLimit(): int
    {
        return $this->limit;
    }

    public function getRemainingAttempts(): int
    {
        return $this->remainingAttempts;
    }

    public function getResetAt(): DateTimeImmutable
    {
        return $this->resetAt;
    }
}