Driver::driverCheck() - Code Metrics - Inspection of "Improved "Auto" driver context with tests, new int..." - PHPSocialNetwork/phpfastcache - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v7 ( c2ec86...629ebb )

by Georges

created 2018-04-07 16:42 UTC

Driver::driverCheck() A

↳ Parent: Driver

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 *
 * This file is part of phpFastCache.
 *
 * @license MIT License (MIT)
 *
 * For full copyright and license information, please see the docs/CREDITS.txt file.
 *
 * @author Khoa Bui (khoaofgod)  <[email protected]> http://www.phpfastcache.com
 * @author Georges.L (Geolim4)  <[email protected]>
 *
 */
declare(strict_types=1);

namespace Phpfastcache\Drivers\Cookie;

use Phpfastcache\Core\Pool\{DriverBaseTrait, ExtendedCacheItemPoolInterface};
use Phpfastcache\Entities\DriverStatistic;
use Phpfastcache\Exceptions\{
  PhpfastcacheInvalidArgumentException, PhpfastcacheDriverException
};
use Psr\Cache\CacheItemInterface;

/**
 * Class Driver
 * @package phpFastCache\Drivers
 * @property Config $config Config object
 * @method Config getConfig() Return the config object
 */
class Driver implements ExtendedCacheItemPoolInterface
{
    use DriverBaseTrait;

    const PREFIX = 'PFC_';

    /**
     * @return bool
     */
    public function driverCheck(): bool
    {
        return \function_exists('setcookie');
    }

    /**
     * @return bool
     */
    protected function driverConnect(): bool
    {
        return !(!\array_key_exists('phpFastCache', $_COOKIE) && !@setcookie('phpFastCache', 1, 10));
    }

    /**
     * @param \Psr\Cache\CacheItemInterface $item
     * @return null|array
     * @throws \Phpfastcache\Exceptions\PhpfastcacheDriverException
     */
    protected function driverRead(CacheItemInterface $item)
    {
        $this->driverConnect();
        $keyword = self::PREFIX . $item->getKey();
        $x = isset($_COOKIE[ $keyword ]) ? \json_decode($_COOKIE[ $keyword ], true) : false;

        if ($x == false) {
            return null;
        }

        if (!is_scalar($this->driverUnwrapData($x)) && !is_null($this->driverUnwrapData($x))) {
            throw new PhpfastcacheDriverException('Hacking attempt: The decoding returned a non-scalar value, Cookie driver does not allow this.');
        }

        return $x;
    }

    /**
     * @param \Psr\Cache\CacheItemInterface $item
     * @return bool
     * @throws PhpfastcacheInvalidArgumentException
     */
    protected function driverWrite(CacheItemInterface $item): bool
    {
        /**
         * Check for Cross-Driver type confusion
         */
        if ($item instanceof Item) {
            $this->driverConnect();
            $keyword = self::PREFIX . $item->getKey();
            $v = \json_encode($this->driverPreWrap($item));

            if ($this->getConfig()->getLimitedMemoryByObject() !== null && \strlen($v) > $this->getConfig()->getLimitedMemoryByObject()) {
                return false;
            }

            return setcookie($keyword, $v, $item->getExpirationDate()->getTimestamp(), '/');
        }
        throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
    }

    /**
     * @param string $key
     * @return int
     */
    protected function driverReadExpirationDate($key): int
    {
        $this->driverConnect();
        $keyword = self::PREFIX . $key;
        $x = isset($_COOKIE[ $keyword ]) ? $this->decode(\json_decode($_COOKIE[ $keyword ])->t) : 0;

        return $x ? $x - \time() : $x;
    }

    /**
     * @param \Psr\Cache\CacheItemInterface $item
     * @return bool
     * @throws PhpfastcacheInvalidArgumentException
     */
    protected function driverDelete(CacheItemInterface $item)
    {
        /**
         * Check for Cross-Driver type confusion
         */
        if ($item instanceof Item) {
            $this->driverConnect();
            $keyword = self::PREFIX . $item->getKey();
            $_COOKIE[ $keyword ] = null;

            return @setcookie($keyword, null, -10);
        }

        throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
    }

    /**
     * @return bool
     */
    protected function driverClear(): bool
    {
        $return = null;
        $this->driverConnect();
        foreach ($_COOKIE as $keyword => $value) {
            if (\strpos($keyword, self::PREFIX) !== false) {
                $_COOKIE[ $keyword ] = null;
                $result = @setcookie($keyword, null, -10);
                if ($return !== false) {
                    $return = $result;
                }
            }
        }

        return $return;

    }

    /**
     * @inheritdoc
     */
    public static function isUsableInAutoContext(): bool
    {
        return false;
    }

    /********************
     *
     * PSR-6 Extended Methods
     *
     *******************/

    /**
     * @return DriverStatistic
     */
    public function getStats(): DriverStatistic
    {
        $size = 0;
        $stat = new DriverStatistic();
        $stat->setData($_COOKIE);

        /**
         * Only count PFC Cookie
         */
        foreach ($_COOKIE as $key => $value) {
            if (\strpos($key, self::PREFIX) === 0) {
                $size += \strlen($value);
            }
        }

        $stat->setSize($size);

        return $stat;
    }
}

1			<?php
2			/**
3			*
4			* This file is part of phpFastCache.
5			*
6			* @license MIT License (MIT)
7			*
8			* For full copyright and license information, please see the docs/CREDITS.txt file.
9			*
10			* @author Khoa Bui (khoaofgod) <[email protected]> http://www.phpfastcache.com
11			* @author Georges.L (Geolim4) <[email protected]>
12			*
13			*/
14			declare(strict_types=1);
15
16			namespace Phpfastcache\Drivers\Cookie;
17
18			use Phpfastcache\Core\Pool\{DriverBaseTrait, ExtendedCacheItemPoolInterface};
19			use Phpfastcache\Entities\DriverStatistic;
20			use Phpfastcache\Exceptions\{
21			PhpfastcacheInvalidArgumentException, PhpfastcacheDriverException
22			};
23			use Psr\Cache\CacheItemInterface;
24
25			/**
26			* Class Driver
27			* @package phpFastCache\Drivers
28			* @property Config $config Config object
29			* @method Config getConfig() Return the config object
30			*/
31			class Driver implements ExtendedCacheItemPoolInterface
32			{
33			use DriverBaseTrait;
34
35			const PREFIX = 'PFC_';
36
37			/**
38			* @return bool
39			*/
40			public function driverCheck(): bool
41			{
42			return \function_exists('setcookie');
43			}
44
45			/**
46			* @return bool
47			*/
48			protected function driverConnect(): bool
49			{
50			return !(!\array_key_exists('phpFastCache', $_COOKIE) && !@setcookie('phpFastCache', 1, 10));
51			}
52
53			/**
54			* @param \Psr\Cache\CacheItemInterface $item
55			* @return null\|array
56			* @throws \Phpfastcache\Exceptions\PhpfastcacheDriverException
57			*/
58			protected function driverRead(CacheItemInterface $item)
59			{
60			$this->driverConnect();
61			$keyword = self::PREFIX . $item->getKey();
62			$x = isset($_COOKIE[ $keyword ]) ? \json_decode($_COOKIE[ $keyword ], true) : false;
63
64			if ($x == false) {
65			return null;
66			}
67
68			if (!is_scalar($this->driverUnwrapData($x)) && !is_null($this->driverUnwrapData($x))) {
69			throw new PhpfastcacheDriverException('Hacking attempt: The decoding returned a non-scalar value, Cookie driver does not allow this.');
70			}
71
72			return $x;
73			}
74
75			/**
76			* @param \Psr\Cache\CacheItemInterface $item
77			* @return bool
78			* @throws PhpfastcacheInvalidArgumentException
79			*/
80			protected function driverWrite(CacheItemInterface $item): bool
81			{
82			/**
83			* Check for Cross-Driver type confusion
84			*/
85			if ($item instanceof Item) {
86			$this->driverConnect();
87			$keyword = self::PREFIX . $item->getKey();
88			$v = \json_encode($this->driverPreWrap($item));
89
90			if ($this->getConfig()->getLimitedMemoryByObject() !== null && \strlen($v) > $this->getConfig()->getLimitedMemoryByObject()) {
91			return false;
92			}
93
94			return setcookie($keyword, $v, $item->getExpirationDate()->getTimestamp(), '/');
95			}
96			throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
97			}
98
99			/**
100			* @param string $key
101			* @return int
102			*/
103			protected function driverReadExpirationDate($key): int
104			{
105			$this->driverConnect();
106			$keyword = self::PREFIX . $key;
107			$x = isset($_COOKIE[ $keyword ]) ? $this->decode(\json_decode($_COOKIE[ $keyword ])->t) : 0;
108
109			return $x ? $x - \time() : $x;
110			}
111
112			/**
113			* @param \Psr\Cache\CacheItemInterface $item
114			* @return bool
115			* @throws PhpfastcacheInvalidArgumentException
116			*/
117			protected function driverDelete(CacheItemInterface $item)
118			{
119			/**
120			* Check for Cross-Driver type confusion
121			*/
122			if ($item instanceof Item) {
123			$this->driverConnect();
124			$keyword = self::PREFIX . $item->getKey();
125			$_COOKIE[ $keyword ] = null;
126
127			return @setcookie($keyword, null, -10);
128			}
129
130			throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
131			}
132
133			/**
134			* @return bool
135			*/
136			protected function driverClear(): bool
137			{
138			$return = null;
139			$this->driverConnect();
140			foreach ($_COOKIE as $keyword => $value) {
141			if (\strpos($keyword, self::PREFIX) !== false) {
142			$_COOKIE[ $keyword ] = null;
143			$result = @setcookie($keyword, null, -10);
144			if ($return !== false) {
145			$return = $result;
146			}
147			}
148			}
149
150			return $return;
			0 ignored issues – show Bug Best Practice introduced 2018-04-07 16:44 UTC by Report Bug Copy Issue Report The expression `return $return` could return the type `null` which is incompatible with the type-hinted return `boolean`. Consider adding an additional type-check to rule them out. Loading history...
151			}
152
153			/**
154			* @inheritdoc
155			*/
156			public static function isUsableInAutoContext(): bool
157			{
158			return false;
159			}
160
161			/********************
162			*
163			* PSR-6 Extended Methods
164			*
165			*******************/
166
167			/**
168			* @return DriverStatistic
169			*/
170			public function getStats(): DriverStatistic
171			{
172			$size = 0;
173			$stat = new DriverStatistic();
174			$stat->setData($_COOKIE);
175
176			/**
177			* Only count PFC Cookie
178			*/
179			foreach ($_COOKIE as $key => $value) {
180			if (\strpos($key, self::PREFIX) === 0) {
181			$size += \strlen($value);
182			}
183			}
184
185			$stat->setSize($size);
186
187			return $stat;
188			}
189			}

PHPSocialNetwork / phpfastcache

Push — v7 ( c2ec86...629ebb )

Driver::driverCheck() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like