Projectmentor\Quota\Stubs\TokenBucketData

Complexity

Total Complexity

6

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getCapacity()	0	4	1
A	getRate()	0	4	1
A	getStorage()	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 TokenBucket data class.
 *
 * It stubs constructor parameters for:
 * bandwithThottle\tokenBucket\TokenBucket
 *
 * Initial properties for a new TokenBucket instance via
 * \Projectmentor\Quota\Factories\FactoryInterface
 *
 * @author David Faith <david@projectmentor.org>
 */
class TokenBucketData implements PayloadInterface
{
    /**
     * The maximum token capacity
     * @var int
     */
    protected $capacity;

    /**
     * The bucket refresh rate
     * @var \bandwithThrottle\tokenBucket\Rate
     */
    protected $rate;

    /**
     * The storage instance
     * @var \bandwidthThrottle\tokenBucket\storage\FileStorage
     */
    protected $storage;

    /**
     * Initialize $this
     * @param int $capacity of the bucket
     * @param \bandwithThrottle\tokenBucket\Rate
     * @param \bandwidthThrottle\tokenBucket\storage\FileStorage
     * @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($capacity, $rate, $storage)
    {
        $this->capacity = $capacity;
        $this->rate = $rate;

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

        $this->storage = $storage;

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

    }

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

    /**
     * Get Rate instance
     *
     * @return \bandwidthThrottle\tokenBucket\Rate

Should the return type not be \bandwithThrottle\tokenBucket\Rate?

     */
    public function getRate()
    {
        return $this->rate;
    }

    /**
     * Get the storage instance.
     *
     * @return \bandwithThrottle\tokenBucket\storage\FileStorage

Should the return type not be \bandwidthThrottle\tokenBucket\storage\FileStorage?

     */
    public function getStorage()
    {
        return $this->storage;
    }

    /**
     * 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.