CacheableResponse::getResponse() - Code Metrics - Inspection of "Introduced "Cacheable Response" feature" - PHPSocialNetwork/phpfastcache-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — V3 ( c9215a...5cd01a )

by Georges

created 2018-05-12 01:15 UTC

CacheableResponse::getResponse() B

↳ Parent: CacheableResponse

Complexity

Conditions	3
Paths	3

Size

Total Lines	34
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	34
rs	8.8571
c	0
b	0
f	0
cc	3
eloc	21
nc	3
nop	3

<?php
/**
 * Created by PhpStorm.
 * User: Geolim4
 * Date: 12/05/2018
 * Time: 02:18
 */

namespace Phpfastcache\Bundle\Response;

use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
use Phpfastcache\Exceptions\PhpfastcacheLogicException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class CacheableResponse
{
    const RESPONSE_PREFIX = '__CACH_RESP__';

    /**
     * @var ExtendedCacheItemPoolInterface
     */
    protected $request;

    /**
     * @var ExtendedCacheItemPoolInterface
     */
    protected $cacheInstance;

    /**
     * CachePromise constructor.
     * @param ExtendedCacheItemPoolInterface $cacheInstance
     */
    public function __construct(ExtendedCacheItemPoolInterface $cacheInstance, Request $request)

    {
        $this->cacheInstance = $cacheInstance;
        $this->request = $request;

    }

    /**
     * @param string $cacheKey
     * @param int|\DateInterval $expiresAfter
     * @param callable $callback
     * @return mixed
     * @throws PhpfastcacheLogicException
     */
    public function getResponse(string $cacheKey, $expiresAfter = null, callable $callback): Response
    {
        $cacheKey = self::RESPONSE_PREFIX . $cacheKey;
        $cacheItem = $this->cacheInstance->getItem($cacheKey);
        $cacheResponse = $cacheItem->get();

        /**
         * No isHit() test here as we directly
         * test if the cached response object
         * is effectively a "Response" object
         */
        if (!($cacheResponse instanceof Response)) {
            $response = $callback();
            if($response instanceof Response){
                $cacheItem->expiresAfter($expiresAfter);

                $response->setExpires($cacheItem->getExpirationDate());
                $response->setSharedMaxAge($cacheItem->getTtl());
                $response->headers->addCacheControlDirective('must-revalidate', true);
                $response->setEtag(md5($response->getContent()));
                $response->setPublic();

                $cacheItem->set($response);
                $this->cacheInstance->save($cacheItem);
                $cacheResponse = $response;
            }else{
               throw new PhpfastcacheLogicException('Your callback response MUST return a valid Symfony HTTP Foundation Response object');
            }
        }else{
            $cacheResponse->isNotModified($this->request);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        return $cacheResponse;
    }
}

1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: Geolim4
5			* Date: 12/05/2018
6			* Time: 02:18
7			*/
8
9			namespace Phpfastcache\Bundle\Response;
10
11			use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
12			use Phpfastcache\Exceptions\PhpfastcacheLogicException;
13			use Symfony\Component\HttpFoundation\Request;
14			use Symfony\Component\HttpFoundation\Response;
15
16			class CacheableResponse
17			{
18			const RESPONSE_PREFIX = '__CACH_RESP__';
19
20			/**
21			* @var ExtendedCacheItemPoolInterface
22			*/
23			protected $request;
24
25			/**
26			* @var ExtendedCacheItemPoolInterface
27			*/
28			protected $cacheInstance;
29
30			/**
31			* CachePromise constructor.
32			* @param ExtendedCacheItemPoolInterface $cacheInstance
33			*/
34			public function __construct(ExtendedCacheItemPoolInterface $cacheInstance, Request $request)
			0 ignored issues – show Bug introduced 2018-05-12 01:17 UTC by Report Bug Copy Issue Report 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()`. Loading history...
35			{
36			$this->cacheInstance = $cacheInstance;
37			$this->request = $request;
			0 ignored issues – show Documentation Bug introduced 2018-05-12 01:17 UTC by Report Bug Copy Issue Report It seems like `$request` of type `object<Symfony\Component\HttpFoundation\Request>` is incompatible with the declared type `object<Phpfastcache\Core...CacheItemPoolInterface>` of property `$request`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
38			}
39
40			/**
41			* @param string $cacheKey
42			* @param int\|\DateInterval $expiresAfter
43			* @param callable $callback
44			* @return mixed
45			* @throws PhpfastcacheLogicException
46			*/
47			public function getResponse(string $cacheKey, $expiresAfter = null, callable $callback): Response
48			{
49			$cacheKey = self::RESPONSE_PREFIX . $cacheKey;
50			$cacheItem = $this->cacheInstance->getItem($cacheKey);
51			$cacheResponse = $cacheItem->get();
52
53			/**
54			* No isHit() test here as we directly
55			* test if the cached response object
56			* is effectively a "Response" object
57			*/
58			if (!($cacheResponse instanceof Response)) {
59			$response = $callback();
60			if($response instanceof Response){
61			$cacheItem->expiresAfter($expiresAfter);
62
63			$response->setExpires($cacheItem->getExpirationDate());
64			$response->setSharedMaxAge($cacheItem->getTtl());
65			$response->headers->addCacheControlDirective('must-revalidate', true);
66			$response->setEtag(md5($response->getContent()));
67			$response->setPublic();
68
69			$cacheItem->set($response);
70			$this->cacheInstance->save($cacheItem);
71			$cacheResponse = $response;
72			}else{
73			throw new PhpfastcacheLogicException('Your callback response MUST return a valid Symfony HTTP Foundation Response object');
74			}
75			}else{
76			$cacheResponse->isNotModified($this->request);
			0 ignored issues – show Documentation introduced 2018-05-12 01:17 UTC by Report Bug Copy Issue Report `$this->request` is of type `object<Phpfastcache\Core...CacheItemPoolInterface>`, but the function expects a `object<Symfony\Component\HttpFoundation\Request>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
77			}
78
79			return $cacheResponse;
80			}
81			}

PHPSocialNetwork / phpfastcache-bundle

Push — V3 ( c9215a...5cd01a )

CacheableResponse::getResponse() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like