responsible\core\throttle\limiterOptions

Complexity

Total Complexity

31

Size/Duplication

Total Lines	219
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	hasOptionProperty()	0	9	4
A	getTimeframe()	0	3	1
A	setLeakRate()	0	15	5
A	getCapacity()	0	3	1
A	setUnlimited()	0	11	4
A	setCapacity()	0	15	5
A	getLeakRate()	0	3	1
A	setTimeframe()	0	27	6
A	setDebugMode()	0	11	3
A	isUnlimited()	0	3	1

<?php
/**
 * ==================================
 * Responsible PHP API
 * ==================================
 *
 * @link Git https://github.com/vince-scarpa/responsibleAPI.git
 *
 * @api Responible API
 * @package responsible\core\throttle
 *
 * @author Vince scarpa <vince.in2net@gmail.com>
 *
 */
namespace responsible\core\throttle;

use responsible\core\server;
use responsible\core\exception;

class limiterOptions
{
    use \responsible\core\traits\optionsTrait;

    /**
     * [$capacity Bucket volume]
     * @var integer
     */
    protected $capacity = 100;

    /**
     * [$leakRate Constant rate at which the bucket will leak]
     * @var string|integer
     */
    protected $leakRate = 1;

    /**
     * [$timeframe Durations are in seconds]
     * @var array
     */
    protected static $timeframe = [
        'SECOND' => 1,
        'MINUTE' => 60,
        'HOUR' => 3600,
        'DAY' => 86400,
        'CUSTOM' => 0,
    ];

    /**
     * [$window Timeframe window]
     * @var integer|string
     */
    protected $window = 'MINUTE';

    /**
     * [$unlimited Rate limiter bypass if true]
     * @var boolean
     */
    protected $unlimited = false;

    /**
     * [$account User account object]
     */
    protected $account;

    /**
     * [$isMockTest Set the mock test]
     * @var boolean
     */
    protected $isMockTest = false;

    /**
     * [$mockAccount Set the mock account]
     * @var object
     */
    protected $mockAccount;

    /**
     * [$scope Set the default scope]
     * @var string
     */
    protected $scope = 'private';

    /**
     * [hasOptionProperty Check if an option property is set]
     * @param  array  $options
     * @param  string  $property
     * @return string|integer|boolean
     */
    protected function hasOptionProperty(array $options, $property, $default = false)
    {
        $val = isset($options[$property]) ? $options[$property] : $default;

        if ($val && empty($options[$property])) {
            $val = $default;
        }

        return $val;
    }

    /**
     * [setCapacity Set the buckets capacity]
     */
    protected function setCapacity($limit = null)
    {
        $options = $this->getOptions();

        if (!is_null($limit)) {
            $options['rateLimit'] = $limit;
        }

        $hasCapacityOption = $this->hasOptionProperty($options, 'rateLimit');

        if (!is_numeric($hasCapacityOption) || empty($hasCapacityOption)) {
            $hasCapacityOption = false;
        }

        $this->capacity = ($hasCapacityOption) ? intval($hasCapacityOption) : intval($this->capacity);
    }

    /**
     * [getCapacity Get the buckets capacity]
     * @return integer
     */
    public function getCapacity()
    {
        return $this->capacity;
    }

    /**
     * [setTimeframe Set the window timeframe]
     */
    protected function setTimeframe($rate = null)
    {
        $options = $this->getOptions();

        if (!is_null($rate)) {
            $options['rateWindow'] = $rate;
        }

        $timeframe = $this->hasOptionProperty($options, 'rateWindow');

        if (is_string($timeframe)) {
            if (isset(self::$timeframe[$timeframe])) {
                $this->window = intval(self::$timeframe[$timeframe]);
                return;
            }
        }

        if (is_numeric($timeframe)) {
            if ($timeframe < 0) {
                $timeframe = ($timeframe*-1);
            }
            self::$timeframe['CUSTOM'] = $timeframe;
            $this->window = intval(self::$timeframe['CUSTOM']);
            return;
        }

        $this->window = self::$timeframe['MINUTE'];
    }

    /**
     * [getTimeframe Get the timeframe window]
     * @return integer|string
     */
    public function getTimeframe()
    {
        return $this->window;
    }

    /**
     * [setLeakRate Set the buckets leak rate]
     * Options: slow, medium, normal, default, fast or custom positive integer
     */
    protected function setLeakRate()
    {
        $options = $this->getOptions();

        if (isset($options['leak']) && !$options['leak']) {
            $options['leakRate'] = 'default';
        }

        $leakRate = $this->hasOptionProperty($options, 'leakRate');

        if (empty($leakRate) || !is_string($leakRate)) {
            $leakRate = 'default';
        }

        $this->leakRate = $leakRate;
    }

    /**
     * [getLeakRate Get the buckets leak rate]
     * @return string|integer
     */
    public function getLeakRate()
    {
        return $this->leakRate;
    }

    /**
     * [setUnlimited Rate limiter bypass]
     */
    protected function setUnlimited()
    {
        $options = $this->getOptions();

        $unlimited = false;

        if (isset($options['unlimited']) && ($options['unlimited'] == 1 || $options['unlimited'] == true)) {
            $unlimited = true;
        }

        $this->unlimited = $unlimited;
    }

    /**
     * [setUnlimited Rate limiter bypass in debug mode]
     */
    protected function setDebugMode()
    {
        $options = $this->getOptions();

        $unlimited = false;

        if (isset($options['requestType']) && $options['requestType'] === 'debug') {
            $unlimited = true;
        }

        $this->unlimited = $unlimited;
    }

    /**
     * [isUnlimited Check if the Responsible API is set to unlimited]
     * @return boolean
     */
    protected function isUnlimited()
    {
        return $this->unlimited;
    }
}