RateLimit\MemcachedRateLimiter

Complexity

Total Complexity

9

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

94.12%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	getCurrent()	0	4	1
A	updateCounter()	0	10	3
A	getElapsedTime()	0	4	1
A	intervalToMemcachedTime()	0	4	2

<?php

declare(strict_types=1);

namespace RateLimit;

use Memcached;

final class MemcachedRateLimiter extends AbstractElapsedTimeRateLimiter
{
    private const MEMCACHED_SECONDS_LIMIT = 2592000; // Number of seconds in 30 days

    /** @var Memcached */
    private $memcached;

    public function __construct(Memcached $memcached, string $keyPrefix = '')
    {
        if ($memcached->getOption(Memcached::OPT_BINARY_PROTOCOL) !== 1) {
            throw new \RuntimeException('Memcached "OPT_BINARY_PROTOCOL" option should be set to "true".');
        }

        parent::__construct($keyPrefix);

        $this->memcached = $memcached;
    }

    protected function getCurrent(string $valueKey): int
    {
        return (int) $this->memcached->get($valueKey);
    }

    protected function updateCounter(string $valueKey, string $timeKey, int $interval): int
    {
        $current = $this->memcached->increment($valueKey, 1, 1, $this->intervalToMemcachedTime($interval));

        if ($current === 1) {
            $this->memcached->add($timeKey, \time(), $this->intervalToMemcachedTime($interval));
        }

        return $current === false ? 1 : $current;
    }

    protected function getElapsedTime(string $timeKey): int
    {
        return \time() - (int) $this->memcached->get($timeKey);
    }

    /**
     * Interval to Memcached expiration time.
     *
     * @see https://www.php.net/manual/en/memcached.expiration.php
     *
     * @param int $interval
     *
     * @return int
     */
    private function intervalToMemcachedTime(int $interval): int
    {
        return $interval <= self::MEMCACHED_SECONDS_LIMIT ? $interval : \time() + $interval;
    }
}