HttpCache::handle() - Code Metrics - Inspection of "cleanup event listener naming" - FriendsOfSymfony/FOSHttpCacheBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#319)

by David

created 2016-11-24 16:44 UTC

HttpCache::handle() A

↳ Parent: HttpCache

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	6
nc	2
nop	3
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;

use FOS\HttpCache\SymfonyCache\CacheEvent;
use FOS\HttpCache\SymfonyCache\UserContextSubscriber;
use Symfony\Bundle\FrameworkBundle\HttpCache\HttpCache as BaseHttpCache;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\HttpKernelInterface;

@trigger_error('The '.__NAMESPACE__.'\HttpCache class is deprecated since version 1.2 and will be removed in 2.0. Use FOS\HttpCacheBundle\SymfonyCache\EventDispatchingHttpCache instead.', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

/**
 * Base class for enhanced Symfony reverse proxy based on the symfony FrameworkBundle HttpCache.
 *
 * @deprecated Use FOS\HttpCacheBundle\SymfonyCache\EventDispatchingHttpCache instead
 *
 * @author Jérôme Vieilledent <[email protected]> (courtesy of eZ Systems AS)
 *
 * {@inheritdoc}
 */
abstract class HttpCache extends BaseHttpCache
{
    /**
     * Hash for anonymous user.
     *
     * @deprecated Use the options on UserContextSubscriber instead
     */
    const ANONYMOUS_HASH = '38015b703d82206ebc01d17a39c727e5';

    /**
     * Accept header value to be used to request the user hash to the backend application.
     * It must match the one defined in FOSHttpCacheBundle's configuration.
     *
     * @deprecated Use the options on UserContextSubscriber instead
     */
    const USER_HASH_ACCEPT_HEADER = 'application/vnd.fos.user-context-hash';

    /**
     * Name of the header the user context hash will be stored into.
     * It must match the one defined in FOSHttpCacheBundle's configuration.
     *
     * @deprecated Use the options on UserContextSubscriber instead
     */
    const USER_HASH_HEADER = 'X-User-Context-Hash';

    /**
     * URI used with the forwarded request for user context hash generation.
     *
     * @deprecated Use the options on UserContextSubscriber instead
     */
    const USER_HASH_URI = '/_fos_user_context_hash';

    /**
     * HTTP Method used with the forwarded request for user context hash generation.
     *
     * @deprecated Use the options on UserContextSubscriber instead
     */
    const USER_HASH_METHOD = 'GET';

    /**
     * Prefix for session names.
     * Must match your session configuration.
     *
     * @deprecated Use the options on UserContextSubscriber instead
     */
    const SESSION_NAME_PREFIX = 'PHPSESSID';

    /**
     * @var UserContextSubscriber
     */
    private $subscriber;

    public function __construct(HttpKernelInterface $kernel, $cacheDir = null)
    {
        parent::__construct($kernel, $cacheDir);

        $this->subscriber = new UserContextSubscriber(array(
            'anonymous_hash' => static::ANONYMOUS_HASH,

            'user_hash_accept_header' => static::USER_HASH_ACCEPT_HEADER,

            'user_hash_header' => static::USER_HASH_HEADER,

            'user_hash_uri' => static::USER_HASH_URI,

            'user_hash_method' => static::USER_HASH_METHOD,

            'session_name_prefix' => static::SESSION_NAME_PREFIX,

        ));
    }

    public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
    {
        $event = new CacheEvent($this, $request);
        $this->subscriber->preHandle($event);
        if ($event->getResponse()) {
            return $event->getResponse();
        }

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


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-02-24 21:51 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 31 and the first side effect is on line 20. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
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;
13
14		use FOS\HttpCache\SymfonyCache\CacheEvent;
15		use FOS\HttpCache\SymfonyCache\UserContextSubscriber;
16		use Symfony\Bundle\FrameworkBundle\HttpCache\HttpCache as BaseHttpCache;
17		use Symfony\Component\HttpFoundation\Request;
18		use Symfony\Component\HttpKernel\HttpKernelInterface;
19
20	1	@trigger_error('The '.__NAMESPACE__.'\HttpCache class is deprecated since version 1.2 and will be removed in 2.0. Use FOS\HttpCacheBundle\SymfonyCache\EventDispatchingHttpCache instead.', E_USER_DEPRECATED);
		0 ignored issues – show Security Best Practice introduced 2016-02-24 21:51 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
21
22		/**
23		* Base class for enhanced Symfony reverse proxy based on the symfony FrameworkBundle HttpCache.
24		*
25		* @deprecated Use FOS\HttpCacheBundle\SymfonyCache\EventDispatchingHttpCache instead
26		*
27		* @author Jérôme Vieilledent <[email protected]> (courtesy of eZ Systems AS)
28		*
29		* {@inheritdoc}
30		*/
31		abstract class HttpCache extends BaseHttpCache
32		{
33		/**
34		* Hash for anonymous user.
35		*
36		* @deprecated Use the options on UserContextSubscriber instead
37		*/
38		const ANONYMOUS_HASH = '38015b703d82206ebc01d17a39c727e5';
39
40		/**
41		* Accept header value to be used to request the user hash to the backend application.
42		* It must match the one defined in FOSHttpCacheBundle's configuration.
43		*
44		* @deprecated Use the options on UserContextSubscriber instead
45		*/
46		const USER_HASH_ACCEPT_HEADER = 'application/vnd.fos.user-context-hash';
47
48		/**
49		* Name of the header the user context hash will be stored into.
50		* It must match the one defined in FOSHttpCacheBundle's configuration.
51		*
52		* @deprecated Use the options on UserContextSubscriber instead
53		*/
54		const USER_HASH_HEADER = 'X-User-Context-Hash';
55
56		/**
57		* URI used with the forwarded request for user context hash generation.
58		*
59		* @deprecated Use the options on UserContextSubscriber instead
60		*/
61		const USER_HASH_URI = '/_fos_user_context_hash';
62
63		/**
64		* HTTP Method used with the forwarded request for user context hash generation.
65		*
66		* @deprecated Use the options on UserContextSubscriber instead
67		*/
68		const USER_HASH_METHOD = 'GET';
69
70		/**
71		* Prefix for session names.
72		* Must match your session configuration.
73		*
74		* @deprecated Use the options on UserContextSubscriber instead
75		*/
76		const SESSION_NAME_PREFIX = 'PHPSESSID';
77
78		/**
79		* @var UserContextSubscriber
80		*/
81		private $subscriber;
82
83	4	public function __construct(HttpKernelInterface $kernel, $cacheDir = null)
84		{
85	4	parent::__construct($kernel, $cacheDir);
86
87	4	$this->subscriber = new UserContextSubscriber(array(
88	4	'anonymous_hash' => static::ANONYMOUS_HASH,
		0 ignored issues – show Deprecated Code introduced 2015-12-04 10:14 UTC by Report Bug Copy Issue Report The constant `FOS\HttpCacheBundle\HttpCache::ANONYMOUS_HASH` has been deprecated with message: Use the options on UserContextSubscriber instead This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
89	4	'user_hash_accept_header' => static::USER_HASH_ACCEPT_HEADER,
		0 ignored issues – show Deprecated Code introduced 2015-12-04 10:14 UTC by Report Bug Copy Issue Report The constant `FOS\HttpCacheBundle\Http...USER_HASH_ACCEPT_HEADER` has been deprecated with message: Use the options on UserContextSubscriber instead This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
90	4	'user_hash_header' => static::USER_HASH_HEADER,
		0 ignored issues – show Deprecated Code introduced 2015-12-04 10:14 UTC by Report Bug Copy Issue Report The constant `FOS\HttpCacheBundle\HttpCache::USER_HASH_HEADER` has been deprecated with message: Use the options on UserContextSubscriber instead This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
91	4	'user_hash_uri' => static::USER_HASH_URI,
		0 ignored issues – show Deprecated Code introduced 2015-12-04 10:14 UTC by Report Bug Copy Issue Report The constant `FOS\HttpCacheBundle\HttpCache::USER_HASH_URI` has been deprecated with message: Use the options on UserContextSubscriber instead This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
92	4	'user_hash_method' => static::USER_HASH_METHOD,
		0 ignored issues – show Deprecated Code introduced 2015-12-04 10:14 UTC by Report Bug Copy Issue Report The constant `FOS\HttpCacheBundle\HttpCache::USER_HASH_METHOD` has been deprecated with message: Use the options on UserContextSubscriber instead This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
93	4	'session_name_prefix' => static::SESSION_NAME_PREFIX,
		0 ignored issues – show Deprecated Code introduced 2015-12-04 10:14 UTC by Report Bug Copy Issue Report The constant `FOS\HttpCacheBundle\HttpCache::SESSION_NAME_PREFIX` has been deprecated with message: Use the options on UserContextSubscriber instead This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
94		));
95	4	}
96
97	4	public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
98		{
99	4	$event = new CacheEvent($this, $request);
100	4	$this->subscriber->preHandle($event);
101	4	if ($event->getResponse()) {
102	2	return $event->getResponse();
103		}
104
105	2	return parent::handle($request, $type, $catch);
106		}
107		}
108

FriendsOfSymfony / FOSHttpCacheBundle

Pull Request — master (#319)

HttpCache::handle() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like