Graviton\RestBundle\Event\RestEvent

Complexity

Total Complexity

7

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setRequest()	0	6	1
A	getRequest()	0	4	1
A	hasResponse()	0	4	1
A	getResponse()	0	4	1
A	setResponse()	0	6	1
A	setController()	0	6	1
A	getController()	0	4	1

<?php
/**
 * Event that is passed to graviton.rest.event listeners
 */

namespace Graviton\RestBundle\Event;

use Symfony\Component\EventDispatcher\Event;
use Symfony\Component\HttpFoundation\Response;
use Graviton\RestBundle\Controller\RestController;
use Symfony\Component\HttpFoundation\Request;

/**
 * Event that is passed to graviton.rest.event listeners
 *
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class RestEvent extends Event
{

    /**
     * Request object
     *
     * @var \Symfony\Component\HttpFoundation\Request
     */
    private $request = null;

    /**
     * Response object
     *
     * @var \Symfony\Component\HttpFoundation\Response
     */
    private $response = null;

    /**
     * Controller which handles the request
     *
     * @var \Graviton\RestBundle\Controller\RestController
     */
    private $controller = null;

    /**
     * Is there a response?
     *
     * @return boolean
     */
    public function hasResponse()
    {
        return null !== $this->response;
    }

    /**
     * Set the request object
     *
     * @param Request $request Request
     *
     * @return \Graviton\RestBundle\Event\RestEvent $this This
     */
    public function setRequest(Request $request)

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;

        return $this;
    }

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

    /**
     * Set the response object and DON'T stop propagation -> Do this yourself
     * if you need it...
     *
     * @param Response $response Response object
     *
     * @return \Graviton\RestBundle\Event\RestEvent $this This object
     */
    public function setResponse(Response $response)
    {
        $this->response = $response;

        return $this;
    }

    /**
     * Get the response object
     *
     * @return Response $response Response object
     */
    public function getResponse()
    {
        return $this->response;
    }

    /**
     * Set the controller for this request
     * At the moment, the MainController doesn't extend the RestController.
     * As soon this is refactored, we can add a type hint to the method
     *
     * @param RestController $controller Controller
     *
     * @return \Graviton\RestBundle\Event\RestEvent $this This object
     */
    public function setController($controller)
    {
        $this->controller = $controller;

        return $this;
    }

    /**
     * Get the controller
     *
     * @return RestController $controller Controller
     */
    public function getController()
    {
        return $this->controller;
    }
}