Graviton\RestBundle\Subscriber\RestEventSubscriber

Complexity

Total Complexity

7

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

13.33%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getSubscribedEvents()	0	14	1
A	onKernelRequest()	0	7	2
A	getEventObject()	0	20	2
A	onKernelResponse()	0	4	1

<?php
/**
 * handle graviton.rest.event events
 */
namespace Graviton\RestBundle\Subscriber;

use Graviton\RestBundle\Event\RestEvent;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\EventDispatcher\Event;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Subscriber for kernel.request and kernel.response events.
 * This class dispatches the graviton.rest.event event
 *
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  https://opensource.org/licenses/MIT MIT License
 * @link     http://swisscom.ch
 */
final class RestEventSubscriber implements EventSubscriberInterface
{
    /**
     * @var Response
     */
    private $response;

    /**
     * @var RestEvent
     */
    private $restEvent;

    /**
     * @var ContainerInterface
     */
    private $container;

    /**
     * @param Response           $response  Response
     * @param RestEvent          $restEvent Rest event
     * @param ContainerInterface $container Container
     */
    public function __construct(Response $response, RestEvent $restEvent, ContainerInterface $container)
    {
        $this->response = $response;
        $this->restEvent = $restEvent;
        $this->container = $container;
    }

    /**
     * Returns the subscribed events
     *
     * @return array $ret Events to subscribe

Consider making the return type a bit more specific; maybe use array<string,array<string|integer>>.

     */
    public static function getSubscribedEvents()
    {
        /**
         * There is a priority flag to manage execution order.
         * If we need more controll over this, we can use this flag or add
         * pre/post Methods like described here:
         * http://symfony.com/doc/current/components/event_dispatcher/introduction.html (StoreSubscriber)
         */

        return array(
            'kernel.request'  => array("onKernelRequest", 0),
            'kernel.response' => array("onKernelResponse", 0)
        );
    }

    /**
     * Handler for kernel.request events
     *
     * @param GetResponseEvent         $event      Event
     * @param string                   $name       Event name
     * @param EventDispatcherInterface $dispatcher Event dispatcher
     *
     * @return void
     */
    public function onKernelRequest(GetResponseEvent $event, $name, EventDispatcherInterface $dispatcher)
    {
        $restEvent = $this->getEventObject($event);
        if ($restEvent instanceof RestEvent) {
            $dispatcher->dispatch("graviton.rest.request", $restEvent);
        }
    }

    /**
     * Get a RestEvent object -> put this in a factory
     *
     * @param Event $event Original event (kernel.request / kernel.response)
     *
     * @return RestEvent $restEvent
     */
    private function getEventObject(Event $event)
    {
        // get the service name
        list ($serviceName) = explode(":", $event->getRequest()->get('_controller'));

It seems like you code against a specific sub-type and not the parent class Symfony\Component\EventDispatcher\Event as the method getRequest() does only exist in the following sub-classes of Symfony\Component\EventDispatcher\Event: Graviton\RestBundle\Event\RestEvent, Symfony\Component\HttpKernel\Event\FilterControllerArgumentsEvent, Symfony\Component\HttpKernel\Event\FilterControllerEvent, Symfony\Component\HttpKernel\Event\FilterResponseEvent, Symfony\Component\HttpKernel\Event\FinishRequestEvent, Symfony\Component\HttpKernel\Event\GetResponseEvent, Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent, Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent, Symfony\Component\HttpKernel\Event\KernelEvent, Symfony\Component\HttpKernel\Event\PostResponseEvent, Symfony\Component\Security\Http\Event\InteractiveLoginEvent, Symfony\Component\Security\Http\Event\SwitchUserEvent. Maybe you want to instanceof check for one of these explicitly?

        // get the controller which handles this request
        if ($this->container->has($serviceName)) {
            $controller = $this->container->get($serviceName);
            $restEvent = $this->restEvent;
            $restEvent->setRequest($event->getRequest());

It seems like you code against a specific sub-type and not the parent class Symfony\Component\EventDispatcher\Event as the method getRequest() does only exist in the following sub-classes of Symfony\Component\EventDispatcher\Event: Graviton\RestBundle\Event\RestEvent, Symfony\Component\HttpKernel\Event\FilterControllerArgumentsEvent, Symfony\Component\HttpKernel\Event\FilterControllerEvent, Symfony\Component\HttpKernel\Event\FilterResponseEvent, Symfony\Component\HttpKernel\Event\FinishRequestEvent, Symfony\Component\HttpKernel\Event\GetResponseEvent, Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent, Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent, Symfony\Component\HttpKernel\Event\KernelEvent, Symfony\Component\HttpKernel\Event\PostResponseEvent, Symfony\Component\Security\Http\Event\InteractiveLoginEvent, Symfony\Component\Security\Http\Event\SwitchUserEvent. Maybe you want to instanceof check for one of these explicitly?

            $restEvent->setResponse($this->response);
            $restEvent->setController($controller);

            $returnEvent = $restEvent;
        } else {
            $returnEvent = $event;
        }

        return $returnEvent;
    }

    /**
     * Handler for kernel.response events
     *
     * @param FilterResponseEvent      $event      Event
     * @param string                   $name       Event name
     * @param EventDispatcherInterface $dispatcher Event dispatcher
     *
     * @return void
     */
    public function onKernelResponse(FilterResponseEvent $event, $name, EventDispatcherInterface $dispatcher)
    {
        $dispatcher->dispatch("graviton.rest.response", $event);
    }
}