WBW\Library\Core\Model\RateLimitTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getLimit()	0	3	1
A	getRemaining()	0	3	1
A	getReset()	0	3	1
A	setLimit()	0	4	1
A	setRemaining()	0	4	1
A	setReset()	0	4	1

<?php

/*
 * This file is part of the core-library package.
 *
 * (c) 2021 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Library\Core\Model;

use DateTime;

/**
 * Rate limit trait.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Library\Core\Model
 */
trait RateLimitTrait {

    /**
     * Limit.
     *
     * @var int|null
     */
    private $limit;

    /**
     * Remaining.
     *
     * @var int|null
     */
    private $remaining;

    /**
     * Reset.
     *
     * @var DateTime|null
     */
    private $reset;

    /**
     * Get the limit.
     *
     * @return int|null Returns the limit.
     */
    public function getLimit(): ?int {
        return $this->limit;
    }

    /**
     * Get the remaining.
     *
     * @return int|null Returns the remaining.
     */
    public function getRemaining(): ?int {
        return $this->remaining;
    }

    /**
     * Get the reset.
     *
     * @return DateTime|null Returns reset.
     */
    public function getReset(): ?DateTime {
        return $this->reset;
    }

    /**
     * Set the limit.
     *
     * @param int|null $limit The limit.
     * @return self Returns this instance.
     */
    public function setLimit(?int $limit): self {
        $this->limit = $limit;
        return $this;
    }

    /**
     * Set the remaining.
     *
     * @param int|null $remaining The remaining.
     * @return self Returns this instance.
     */
    public function setRemaining(?int $remaining): self {
        $this->remaining = $remaining;
        return $this;
    }

    /**
     * Set the reset.
     *
     * @param DateTime|null $reset The reset.
     * @return self Returns this instance.
     */
    public function setReset(?DateTime $reset): self {
        $this->reset = $reset;
        return $this;
    }
}