EventDispatchingHttpCache::getEventDispatcher() - Code Metrics - Inspection of "Merge pull request #319 from FriendsOfSymfony/even..." - FriendsOfSymfony/FOSHttpCacheBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9bb55b...536c73 )

by David de

created 2016-11-24 16:53 UTC

EventDispatchingHttpCache::getEventDispatcher() A

↳ Parent: EventDispatchingHttpCache

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	4
cts	4
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	0
crap	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 <[email protected]> (courtesy of eZ Systems AS)
 * @author David Buchmann <[email protected]>
 *
 * {@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)

    {
        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)

    {
        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;
    }
}


1			<?php
2
3			/*
4			* This file is part of the FOSHttpCacheBundle package.
5			*
6			* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace FOS\HttpCacheBundle\SymfonyCache;
13
14			use FOS\HttpCache\SymfonyCache\CacheEvent;
15			use FOS\HttpCache\SymfonyCache\Events;
16			use FOS\HttpCache\SymfonyCache\PurgeSubscriber;
17			use FOS\HttpCache\SymfonyCache\RefreshSubscriber;
18			use FOS\HttpCache\SymfonyCache\UserContextSubscriber;
19			use Symfony\Bundle\FrameworkBundle\HttpCache\HttpCache;
20			use Symfony\Component\EventDispatcher\EventDispatcher;
21			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
22			use Symfony\Component\EventDispatcher\EventSubscriberInterface;
23			use Symfony\Component\HttpFoundation\Request;
24			use Symfony\Component\HttpKernel\HttpKernelInterface;
25
26			/**
27			* Base class for enhanced Symfony reverse proxy based on the symfony FrameworkBundle HttpCache.
28			*
29			* This kernel supports event subscribers that can act on the events defined in
30			* FOS\HttpCache\SymfonyCache\Events and may alter the request flow.
31			*
32			* This kernel can auto-register subscribers. Overwrite `getOptions()` in your cache kernel to
33			* return an array with the key "fos_default_subscribers". The value is a bit mask to define which
34			* subscribers should be added with default options. If nothing is specified, the value is
35			* self::SUBSCRIBER_ALL.
36			*
37			* Examples:
38			* - `self::SUBSCRIBER_USER_CONTEXT` (only user context).
39			* - `self::SUBSCRIBER_NONE` (no native subscriber).
40			* - `self::SUBSCRIBER_ALL & ~self::SUBSCRIBER_USER_CONTEXT` (all native ones except the user context one).
41			*
42			* Note: This class looks very similar to the FOSHttpCache library event
43			* dispatching kernel, but extends the FrameworkBundle HttpCache instead of the
44			* one from the HttpKernel component.
45			*
46			* @author Jérôme Vieilledent <[email protected]> (courtesy of eZ Systems AS)
47			* @author David Buchmann <[email protected]>
48			*
49			* {@inheritdoc}
50			*/
51			abstract class EventDispatchingHttpCache extends HttpCache
52			{
53			/**
54			* Option for the "fos_default_subscribers" that enables all subscribers.
55			*
56			* See class phpdoc for examples.
57			*/
58			const SUBSCRIBER_ALL = -1; // Equals to ~0
59
60			/**
61			* Option for the "fos_default_subscribers" that enables no subscribers.
62			*
63			* See class phpdoc for examples.
64			*/
65			const SUBSCRIBER_NONE = 0;
66
67			/**
68			* Option for the "fos_default_subscribers" that enables the user context subscriber.
69			*
70			* See class phpdoc for examples.
71			*/
72			const SUBSCRIBER_USER_CONTEXT = 1;
73
74			/**
75			* Option for the "fos_default_subscribers" that enables the purge subscriber.
76			*
77			* See class phpdoc for examples.
78			*/
79			const SUBSCRIBER_PURGE = 2;
80
81			/**
82			* Option for the "fos_default_subscribers" that enables the refresh subscriber.
83			*
84			* See class phpdoc for examples.
85			*/
86			const SUBSCRIBER_REFRESH = 4;
87
88			/**
89			* @var EventDispatcherInterface
90			*/
91			private $eventDispatcher;
92
93			/**
94			* {@inheritdoc}
95			*
96			* Adding the default subscribers to the event dispatcher.
97			*/
98			public function __construct(HttpKernelInterface $kernel, $cacheDir = null)
99			{
100			parent::__construct($kernel, $cacheDir);
101
102			foreach ($this->getDefaultSubscribers() as $subscriber) {
103			$this->addSubscriber($subscriber);
104			}
105			}
106
107			/**
108			* {@inheritdoc}
109			*
110			* Adding the Events::PRE_HANDLE event.
111			*/
112	2	View Code Duplication	public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
			0 ignored issues – show Duplication introduced 2015-12-04 10:14 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
113			{
114	2		if ($this->getEventDispatcher()->hasListeners(Events::PRE_HANDLE)) {
115	2		$event = new CacheEvent($this, $request);
116	2		$this->getEventDispatcher()->dispatch(Events::PRE_HANDLE, $event);
117	2		if ($event->getResponse()) {
118	1		return $event->getResponse();
119			}
120			}
121
122	1		return parent::handle($request, $type, $catch);
123			}
124
125			/**
126			* Add a cache kernel event subscriber that listens to events listed in
127			* FOS\HttpCache\SymfonyCache\Event.
128			*
129			* @param EventSubscriberInterface $subscriber
130			*/
131	2		public function addSubscriber(EventSubscriberInterface $subscriber)
132			{
133	2		$this->getEventDispatcher()->addSubscriber($subscriber);
134	2		}
135
136			/**
137			* Made public to allow event subscribers to do refresh operations.
138			*
139			* {@inheritdoc}
140			*/
141			public function fetch(Request $request, $catch = false)
142			{
143			return parent::fetch($request, $catch);
144			}
145
146			/**
147			* {@inheritdoc}
148			*
149			* Adding the Events::PRE_INVALIDATE event.
150			*/
151		View Code Duplication	protected function invalidate(Request $request, $catch = false)
			0 ignored issues – show Duplication introduced 2015-12-04 10:14 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
152			{
153			if ($this->getEventDispatcher()->hasListeners(Events::PRE_INVALIDATE)) {
154			$event = new CacheEvent($this, $request);
155			$this->getEventDispatcher()->dispatch(Events::PRE_INVALIDATE, $event);
156			if ($event->getResponse()) {
157			return $event->getResponse();
158			}
159			}
160
161			return parent::invalidate($request, $catch);
162			}
163
164			/**
165			* Return the subscribers to be added to the event dispatcher, according to the
166			* fos_default_subscribers option in `getOptions()`.
167			*
168			* Override this method if you want to customize subscribers or add your own subscribers.
169			*
170			* @return EventSubscriberInterface[]
171			*/
172	4		protected function getDefaultSubscribers()
173			{
174	4		$options = $this->getOptions();
175	4		$subscribers = array();
176	4		$defaultSubscribersOption = isset($options['fos_default_subscribers']) ? $options['fos_default_subscribers'] : self::SUBSCRIBER_ALL;
177	4		if ($defaultSubscribersOption & self::SUBSCRIBER_USER_CONTEXT) {
178	3		$subscribers[] = new UserContextSubscriber();
179			}
180	4		if ($defaultSubscribersOption & self::SUBSCRIBER_PURGE) {
181	2		$subscribers[] = new PurgeSubscriber();
182			}
183	4		if ($defaultSubscribersOption & self::SUBSCRIBER_REFRESH) {
184	2		$subscribers[] = new RefreshSubscriber();
185			}
186
187	4		return $subscribers;
188			}
189
190			/**
191			* Get event dispatcher.
192			*
193			* @return EventDispatcherInterface
194			*/
195	2		private function getEventDispatcher()
196			{
197	2		if (null === $this->eventDispatcher) {
198	2		$this->eventDispatcher = new EventDispatcher();
199			}
200
201	2		return $this->eventDispatcher;
202			}
203			}
204

FriendsOfSymfony / FOSHttpCacheBundle

Push — master ( 9bb55b...536c73 )

EventDispatchingHttpCache::getEventDispatcher() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like