Noxlogic\RateLimitBundle\Events\GenerateKeyEvent

Complexity

Total Complexity

7

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getKey()	0	4	1
A	setKey()	0	4	1
A	getRequest()	0	4	1
A	addToKey()	0	8	2
A	getPayload()	0	4	1

<?php

namespace Noxlogic\RateLimitBundle\Events;

use Symfony\Component\EventDispatcher\Event;
use Symfony\Component\HttpFoundation\Request;

class GenerateKeyEvent extends Event
{

    /** @var Request */
    protected $request;

    /** @var string */
    protected $key;

    /** @var mixed */
    protected $payload;

    public function __construct(Request $request, $key = '', $payload = null)

You have injected the Request via parameter $request. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via getCurrentRequest().

    {
        $this->request = $request;
        $this->key = $key;
        $this->payload = $payload;
    }

    /**
     * @return string
     */
    public function getKey()
    {
        return $this->key;
    }

    /**
     * @param string $key
     */
    public function setKey($key)
    {
        $this->key = $key;
    }

    /**
     * @return Request
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * @param $part
     */
    public function addToKey($part)
    {
        if ($this->key) {
            $this->key .= '.'.$part;
        } else {
            $this->key = $part;
        }
    }

    /**
     * @return mixed
     */
    public function getPayload()
    {
        return $this->payload;
    }
}