FOS\HttpCacheBundle\SymfonyCache\EventDispatchingHttpCache

Complexity

Total Complexity

17

Size/Duplication

Total Lines	153
Duplicated Lines	15.69 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

64.1%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	addSubscriber()	0	4	1
A	fetch()	0	4	1
A	__construct()	0	8	2
A	handle()	12	12	3
A	invalidate()	12	12	3
B	getDefaultSubscribers()	0	17	5
A	getEventDispatcher()	0	8	2

<?php

/*
 * This file is part of the FOSHttpCacheBundle package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\HttpCacheBundle\SymfonyCache;

use FOS\HttpCache\SymfonyCache\CacheEvent;
use FOS\HttpCache\SymfonyCache\Events;
use FOS\HttpCache\SymfonyCache\PurgeSubscriber;
use FOS\HttpCache\SymfonyCache\RefreshSubscriber;
use FOS\HttpCache\SymfonyCache\UserContextSubscriber;
use Symfony\Bundle\FrameworkBundle\HttpCache\HttpCache;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\HttpKernelInterface;

/**
 * Base class for enhanced Symfony reverse proxy based on the symfony FrameworkBundle HttpCache.
 *
 * This kernel supports event subscribers that can act on the events defined in
 * FOS\HttpCache\SymfonyCache\Events and may alter the request flow.
 *
 * This kernel can auto-register subscribers. Overwrite `getOptions()` in your cache kernel to
 * return an array with the key "fos_default_subscribers". The value is a bit mask to define which
 * subscribers should be added with default options. If nothing is specified, the value is
 * self::SUBSCRIBER_ALL.
 *
 * Examples:
 *   - `self::SUBSCRIBER_USER_CONTEXT` (**only** user context).
 *   - `self::SUBSCRIBER_NONE` (**no** native subscriber).
 *   - `self::SUBSCRIBER_ALL & ~self::SUBSCRIBER_USER_CONTEXT` (**all** native ones **except** the user context one).
 *
 * Note: This class looks very similar to the FOSHttpCache library event
 * dispatching kernel, but extends the FrameworkBundle HttpCache instead of the
 * one from the HttpKernel component.
 *
 * @author Jérôme Vieilledent <lolautruche@gmail.com> (courtesy of eZ Systems AS)
 * @author David Buchmann <mail@davidbu.ch>
 *
 * {@inheritdoc}
 */
abstract class EventDispatchingHttpCache extends HttpCache
{
    /**
     * Option for the "fos_default_subscribers" that enables all subscribers.
     *
     * See class phpdoc for examples.
     */
    const SUBSCRIBER_ALL = -1; // Equals to ~0

    /**
     * Option for the "fos_default_subscribers" that enables no subscribers.
     *
     * See class phpdoc for examples.
     */
    const SUBSCRIBER_NONE = 0;

    /**
     * Option for the "fos_default_subscribers" that enables the user context subscriber.
     *
     * See class phpdoc for examples.
     */
    const SUBSCRIBER_USER_CONTEXT = 1;

    /**
     * Option for the "fos_default_subscribers" that enables the purge subscriber.
     *
     * See class phpdoc for examples.
     */
    const SUBSCRIBER_PURGE = 2;

    /**
     * Option for the "fos_default_subscribers" that enables the refresh subscriber.
     *
     * See class phpdoc for examples.
     */
    const SUBSCRIBER_REFRESH = 4;

    /**
     * @var EventDispatcherInterface
     */
    private $eventDispatcher;

    /**
     * {@inheritdoc}
     *
     * Adding the default subscribers to the event dispatcher.
     */
    public function __construct(HttpKernelInterface $kernel, $cacheDir = null)
    {
        parent::__construct($kernel, $cacheDir);

        foreach ($this->getDefaultSubscribers() as $subscriber) {
            $this->addSubscriber($subscriber);
        }
    }

    /**
     * {@inheritdoc}
     *
     * Adding the Events::PRE_HANDLE event.
     */
    public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)

This method seems to be duplicated in your project.

    {
        if ($this->getEventDispatcher()->hasListeners(Events::PRE_HANDLE)) {
            $event = new CacheEvent($this, $request);
            $this->getEventDispatcher()->dispatch(Events::PRE_HANDLE, $event);
            if ($event->getResponse()) {
                return $event->getResponse();
            }
        }

        return parent::handle($request, $type, $catch);
    }

    /**
     * Add a cache kernel event subscriber that listens to events listed in
     * FOS\HttpCache\SymfonyCache\Event.
     *
     * @param EventSubscriberInterface $subscriber
     */
    public function addSubscriber(EventSubscriberInterface $subscriber)
    {
        $this->getEventDispatcher()->addSubscriber($subscriber);
    }

    /**
     * Made public to allow event subscribers to do refresh operations.
     *
     * {@inheritdoc}
     */
    public function fetch(Request $request, $catch = false)
    {
        return parent::fetch($request, $catch);
    }

    /**
     * {@inheritdoc}
     *
     * Adding the Events::PRE_INVALIDATE event.
     */
    protected function invalidate(Request $request, $catch = false)

This method seems to be duplicated in your project.

    {
        if ($this->getEventDispatcher()->hasListeners(Events::PRE_INVALIDATE)) {
            $event = new CacheEvent($this, $request);
            $this->getEventDispatcher()->dispatch(Events::PRE_INVALIDATE, $event);
            if ($event->getResponse()) {
                return $event->getResponse();
            }
        }

        return parent::invalidate($request, $catch);
    }

    /**
     * Return the subscribers to be added to the event dispatcher, according to the
     * fos_default_subscribers option in `getOptions()`.
     *
     * Override this method if you want to customize subscribers or add your own subscribers.
     *
     * @return EventSubscriberInterface[]
     */
    protected function getDefaultSubscribers()
    {
        $options = $this->getOptions();
        $subscribers = array();
        $defaultSubscribersOption = isset($options['fos_default_subscribers']) ? $options['fos_default_subscribers'] : self::SUBSCRIBER_ALL;
        if ($defaultSubscribersOption & self::SUBSCRIBER_USER_CONTEXT) {
            $subscribers[] = new UserContextSubscriber();
        }
        if ($defaultSubscribersOption & self::SUBSCRIBER_PURGE) {
            $subscribers[] = new PurgeSubscriber();
        }
        if ($defaultSubscribersOption & self::SUBSCRIBER_REFRESH) {
            $subscribers[] = new RefreshSubscriber();
        }

        return $subscribers;
    }

    /**
     * Get event dispatcher.
     *
     * @return EventDispatcherInterface
     */
    private function getEventDispatcher()
    {
        if (null === $this->eventDispatcher) {
            $this->eventDispatcher = new EventDispatcher();
        }

        return $this->eventDispatcher;
    }
}