Projectmentor\Quota\Stubs\RateData

Complexity

Total Complexity

5

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getLimit()	0	4	1
A	getPeriod()	0	4	1
A	toJson()	0	4	1
A	toArray()	0	4	1

<?php

/**
 * This file is part of laravel-quota
 *
 * (c) David Faith <david@projectmentor.org>
 *
 * Full copyright and license information is available
 * in the LICENSE file distributed with this source code.
 */

namespace Projectmentor\Quota\Stubs;

use Projectmentor\Quota\Contracts\PayloadInterface;

/**
 * This is the rate data class.
 *
 * It stubs constructor parameters for:
 * bandwithThottle\tokenBucket\Rate
 *
 * Initial properties for a new Rate instance via
 * Projectmentor\Quota\Factories\FactoryInterface
 *
 * @author David Faith <david@projectmentor.org>
 */
class RateData implements PayloadInterface
{
    /**
     * The rate limit
     * i.e. capacity of the token-bucket
     * @var string
     */
    protected $limit;

    /**
     * The time period constant from Rate
     * @var string
     */
    protected $period;

    /**
     * Initialize $this
     * @param int $limit capacity
     * @param string $period Rate::<CONSTANT>
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($limit, $period)
    {
        $this->limit = $limit;

The property $limit was declared of type string, but $limit is of type integer. Maybe add a type cast?

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

        $this->period = $period;
    }

    /**
     * Get the token bucket capacity
     * i.e: the maximum number of
     * tokens available at any time.
     * @return
     */
    public function getLimit()
    {
        return $this->limit;
    }

    /**
     * Get the constant name for the
     * time period between
     * bucket refill.
     * e.g: 'SECOND' | 'DAY' ...
     *
     * @return string
     */
    public function getPeriod()
    {
        return $this->period;
    }

    /**
     * Implements PayloadInterface
     * emit json payload.
     * @return string
     */
    public function toJson()
    {
        return 'Hi';
    }

    /**
     * Implements PayloadInterface
     * emit array payload.
     * @return string

Should the return type not be string[]?

     */
    public function toArray()
    {
        return ['Hi'];
    }
}

As per coding style, files should not end with a newline character.