Zenstruck\Governator\Key

Complexity

Total Complexity

10

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	resource()	0	3	1
A	ttl()	0	3	1
A	__construct()	0	18	4
A	limit()	0	3	1
A	createCounter()	0	3	1
A	__toString()	0	3	2

<?php

namespace Zenstruck\Governator;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
final class Key
{
    private string $resource;
    private int $limit;
    private int $ttl;
    private string $prefix;
    private ?string $string = null;

    public function __construct(string $resource, int $limit, int $ttl, string $prefix = '')
    {
        if (empty($resource)) {
            throw new \InvalidArgumentException('A non-empty string is required for a throttle\'s "resource".');
        }

        if ($limit < 1) {
            throw new \InvalidArgumentException('A positive integer is required for a throttle\'s "limit".');
        }

        if ($ttl < 1) {
            throw new \InvalidArgumentException('A positive number is required for a throttle\'s "time to live".');
        }

        $this->resource = $resource;
        $this->limit = $limit;
        $this->ttl = $ttl;
        $this->prefix = $prefix;
    }

    public function __toString(): string
    {
        return $this->string ?: $this->string = $this->prefix.\rtrim(\strtr(\base64_encode($this->resource), '+/', '-_'), '=').$this->limit.$this->ttl;
    }

    public function createCounter(): Counter
    {
        return new Counter(0, time() + $this->ttl);
    }

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

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

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