Yiisoft\Yii\RateLimiter\Storage\ApcuStorage

Complexity

Total Complexity

13

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	2

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	3
A	saveIfNotExists()	0	9	3
A	saveCompareAndSwap()	0	14	5
A	get()	0	8	2

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\RateLimiter\Storage;

use InvalidArgumentException;
use Yiisoft\Yii\RateLimiter\Exception\CannotUseException;

final class ApcuStorage implements StorageInterface
{
    private const DEFAULT_FIX_PRECISION_RATE = 1000000;

    /**
     * @param int $fixPrecisionRate 
     * floating point is not supported by apcu_cas of ACPu, so use it to improve precision.
     */
    public function __construct(
        private int $fixPrecisionRate = self::DEFAULT_FIX_PRECISION_RATE
    ) {
        if (!extension_loaded('apcu') || ini_get('apc.enabled') === '0') {
            throw new CannotUseException('APCu extension is not loaded or not enabled.');
        }
    }

    public function saveIfNotExists(string $key, mixed $value, int $ttl): bool
    {
        if ((!is_int($value)) && !is_float($value)) {
            throw new InvalidArgumentException('The value must be int or float, is not supported by ApcuStorage');
        }

        $value = (int) ($value * $this->fixPrecisionRate);

        return (bool)apcu_add($key, $value, $ttl);
    }

    public function saveCompareAndSwap(string $key, mixed $oldValue, mixed $newValue, int $ttl): bool
    {
        if ((!is_int($oldValue)) && !is_float($oldValue)) {
            throw new InvalidArgumentException('The oldValue must be int or float, is not supported by ApcuStorage');
        }

        if ((!is_int($newValue)) && !is_float($newValue)) {
            throw new InvalidArgumentException('The newValue must be int or float, is not supported by ApcuStorage');
        }

        $oldValue = (int) ($oldValue * $this->fixPrecisionRate);
        $newValue = (int) ($newValue * $this->fixPrecisionRate);

        return  (bool)apcu_cas($key, $oldValue, $newValue);
    }

    public function get(string $key): mixed
    {
        $value = apcu_fetch($key);
        
        if ($value != false) {
            $value = floatval($value / $this->fixPrecisionRate);
        }
        return $value;
    }
}