ItemBaseTrait::expiresAfter() - Code Metrics - Inspection of "Fixed #620" - PHPSocialNetwork/phpfastcache - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#623)

by Georges

created 2018-06-24 12:44 UTC

ItemBaseTrait::expiresAfter() A

↳ Parent: ItemBaseTrait

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
nc	4
nop	1
dl	0
loc	35
rs	9.36
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]> https://www.phpfastcache.com
 * @author Georges.L (Geolim4)  <[email protected]>
 *
 */
declare(strict_types=1);

namespace Phpfastcache\Core\Item;

use Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException;

/**
 * Trait ItemBaseTrait
 * @package phpFastCache\Core\Item
 */
trait ItemBaseTrait
{
    use ItemExtendedTrait;

    /**
     * @var bool
     */
    protected $fetched = false;

    /**
     * @var string
     */
    protected $key;

    /**
     * @var mixed
     */
    protected $data;

    /**
     * @var \DateTimeInterface
     */
    protected $expirationDate;

    /**
     * @var \DateTimeInterface
     */
    protected $creationDate;

    /**
     * @var \DateTimeInterface
     */
    protected $modificationDate;

    /**
     * @var array
     */
    protected $tags = [];

    /**
     * @var array
     */
    protected $removedTags = [];

    /**
     * @var bool
     */
    protected $isHit = false;

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

    /**
     * @return string
     */
    public function getKey()
    {
        return $this->key;
    }

    /**
     * @return mixed
     */
    public function get()
    {
        return $this->data;
    }

    /**
     * @param mixed $value
     * @return $this
     */
    public function set($value)
    {
        /**
         * The user set a value,
         * therefore there is no need to
         * fetch from source anymore
         */
        $this->fetched = true;
        $this->data = $value;

        /**
         * @eventName CacheSaveDeferredItem
         * @param ExtendedCacheItemInterface $this
         * @param mixed $value
         *
         */
        $this->eventManager->dispatch('CacheItemSet', $this, $value);

        return $this;
    }

    /**
     * @return bool
     */
    public function isHit(): bool
    {
        return $this->isHit;
    }

    /**
     * @param bool $isHit
     * @return ExtendedCacheItemInterface
     * @throws PhpfastcacheInvalidArgumentException
     */
    public function setHit($isHit): ExtendedCacheItemInterface
    {
        if (\is_bool($isHit)) {

            $this->isHit = $isHit;

            return $this;

        }

        throw new PhpfastcacheInvalidArgumentException('$isHit must be a boolean');
    }

    /**
     * @param \DateTimeInterface $expiration
     * @return ExtendedCacheItemInterface
     * @throws PhpfastcacheInvalidArgumentException
     */
    public function expiresAt($expiration): ExtendedCacheItemInterface
    {
        if ($expiration instanceof \DateTimeInterface) {

            /**
             * @eventName CacheItemExpireAt
             * @param ExtendedCacheItemInterface $this
             * @param \DateTimeInterface $expiration
             */
            $this->eventManager->dispatch('CacheItemExpireAt', $this, $expiration);
            $this->expirationDate = $expiration;
        } else {
            throw new PhpfastcacheInvalidArgumentException('$expiration must be an object implementing the DateTimeInterface got: ' . \gettype($expiration));
        }

        return $this;

    }

    /**
     * @param \DateInterval|int $time
     * @return $this
     * @throws PhpfastcacheInvalidArgumentException
     */
    public function expiresAfter($time)
    {
        if (\is_numeric($time)) {
            if ($time <= 0) {
                /**
                 * 5 years, however memcached or memory cached will gone when u restart it
                 * just recommended for sqlite. files
                 */
                $time = 30 * 24 * 3600 * 5;
            }

            /**
             * @eventName CacheItemExpireAt
             * @param ExtendedCacheItemInterface $this
             * @param \DateTimeInterface $expiration
             */
            $this->eventManager->dispatch('CacheItemExpireAfter', $this, $time);

            $this->expirationDate = (new \DateTime())->add(new \DateInterval(\sprintf('PT%dS', $time)));
        } else {
            if ($time instanceof \DateInterval) {

                /**
                 * @eventName CacheItemExpireAt
                 * @param ExtendedCacheItemInterface $this
                 * @param \DateTimeInterface $expiration
                 */
                $this->eventManager->dispatch('CacheItemExpireAfter', $this, $time);

                $this->expirationDate = (new \DateTime())->add($time);
            } else {
                throw new PhpfastcacheInvalidArgumentException(\sprintf('Invalid date format, got "%s"', \gettype($time)));
            }
        }

        return $this;
    }
}


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]> https://www.phpfastcache.com
11			* @author Georges.L (Geolim4) <[email protected]>
12			*
13			*/
14			declare(strict_types=1);
15
16			namespace Phpfastcache\Core\Item;
17
18			use Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException;
19
20			/**
21			* Trait ItemBaseTrait
22			* @package phpFastCache\Core\Item
23			*/
24			trait ItemBaseTrait
25			{
26			use ItemExtendedTrait;
27
28			/**
29			* @var bool
30			*/
31			protected $fetched = false;
32
33			/**
34			* @var string
35			*/
36			protected $key;
37
38			/**
39			* @var mixed
40			*/
41			protected $data;
42
43			/**
44			* @var \DateTimeInterface
45			*/
46			protected $expirationDate;
47
48			/**
49			* @var \DateTimeInterface
50			*/
51			protected $creationDate;
52
53			/**
54			* @var \DateTimeInterface
55			*/
56			protected $modificationDate;
57
58			/**
59			* @var array
60			*/
61			protected $tags = [];
62
63			/**
64			* @var array
65			*/
66			protected $removedTags = [];
67
68			/**
69			* @var bool
70			*/
71			protected $isHit = false;
72
73			/********************
74			*
75			* PSR-6 Methods
76			*
77			*******************/
78
79			/**
80			* @return string
81			*/
82			public function getKey()
83			{
84			return $this->key;
85			}
86
87			/**
88			* @return mixed
89			*/
90			public function get()
91			{
92			return $this->data;
93			}
94
95			/**
96			* @param mixed $value
97			* @return $this
98			*/
99			public function set($value)
100			{
101			/**
102			* The user set a value,
103			* therefore there is no need to
104			* fetch from source anymore
105			*/
106			$this->fetched = true;
107			$this->data = $value;
108
109			/**
110			* @eventName CacheSaveDeferredItem
111			* @param ExtendedCacheItemInterface $this
112			* @param mixed $value
113			*
114			*/
115			$this->eventManager->dispatch('CacheItemSet', $this, $value);
116
117			return $this;
118			}
119
120			/**
121			* @return bool
122			*/
123			public function isHit(): bool
124			{
125			return $this->isHit;
126			}
127
128			/**
129			* @param bool $isHit
130			* @return ExtendedCacheItemInterface
131			* @throws PhpfastcacheInvalidArgumentException
132			*/
133			public function setHit($isHit): ExtendedCacheItemInterface
134			{
135			if (\is_bool($isHit)) {
			0 ignored issues – show introduced 2018-03-09 20:23 UTC by Report Bug Copy Issue Report The condition `is_bool($isHit)` is always `true`. Loading history...
136			$this->isHit = $isHit;
137
138			return $this;
			0 ignored issues – show Bug Best Practice introduced 2018-03-05 21:49 UTC by Report Bug Copy Issue Report The expression `return $this` returns the type `Phpfastcache\Core\Item\ItemBaseTrait` which is incompatible with the type-hinted return `Phpfastcache\Core\Item\ExtendedCacheItemInterface`. Loading history...
139			}
140
141			throw new PhpfastcacheInvalidArgumentException('$isHit must be a boolean');
142			}
143
144			/**
145			* @param \DateTimeInterface $expiration
146			* @return ExtendedCacheItemInterface
147			* @throws PhpfastcacheInvalidArgumentException
148			*/
149			public function expiresAt($expiration): ExtendedCacheItemInterface
150			{
151			if ($expiration instanceof \DateTimeInterface) {
			0 ignored issues – show introduced 2018-03-09 20:23 UTC by Report Bug Copy Issue Report `$expiration` is always a sub-type of `DateTimeInterface`. Loading history...
152			/**
153			* @eventName CacheItemExpireAt
154			* @param ExtendedCacheItemInterface $this
155			* @param \DateTimeInterface $expiration
156			*/
157			$this->eventManager->dispatch('CacheItemExpireAt', $this, $expiration);
158			$this->expirationDate = $expiration;
159			} else {
160			throw new PhpfastcacheInvalidArgumentException('$expiration must be an object implementing the DateTimeInterface got: ' . \gettype($expiration));
161			}
162
163			return $this;
			0 ignored issues – show Bug Best Practice introduced 2018-03-05 21:49 UTC by Report Bug Copy Issue Report The expression `return $this` returns the type `Phpfastcache\Core\Item\ItemBaseTrait` which is incompatible with the type-hinted return `Phpfastcache\Core\Item\ExtendedCacheItemInterface`. Loading history...
164			}
165
166			/**
167			* @param \DateInterval\|int $time
168			* @return $this
169			* @throws PhpfastcacheInvalidArgumentException
170			*/
171			public function expiresAfter($time)
172			{
173			if (\is_numeric($time)) {
174			if ($time <= 0) {
175			/**
176			* 5 years, however memcached or memory cached will gone when u restart it
177			* just recommended for sqlite. files
178			*/
179			$time = 30 * 24 * 3600 * 5;
180			}
181
182			/**
183			* @eventName CacheItemExpireAt
184			* @param ExtendedCacheItemInterface $this
185			* @param \DateTimeInterface $expiration
186			*/
187			$this->eventManager->dispatch('CacheItemExpireAfter', $this, $time);
188
189			$this->expirationDate = (new \DateTime())->add(new \DateInterval(\sprintf('PT%dS', $time)));
190			} else {
191			if ($time instanceof \DateInterval) {
			0 ignored issues – show introduced 2018-03-09 20:23 UTC by Report Bug Copy Issue Report `$time` is always a sub-type of `DateInterval`. Loading history...
192			/**
193			* @eventName CacheItemExpireAt
194			* @param ExtendedCacheItemInterface $this
195			* @param \DateTimeInterface $expiration
196			*/
197			$this->eventManager->dispatch('CacheItemExpireAfter', $this, $time);
198
199			$this->expirationDate = (new \DateTime())->add($time);
200			} else {
201			throw new PhpfastcacheInvalidArgumentException(\sprintf('Invalid date format, got "%s"', \gettype($time)));
202			}
203			}
204
205			return $this;
206			}
207			}
208

PHPSocialNetwork / phpfastcache

Pull Request — master (#623)

ItemBaseTrait::expiresAfter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like