CacheItem::getKey() - Code Metrics - override2k/psr-cache - Measure and Improve Code Quality continuously with Scrutinizer

CacheItem::getKey() A
last analyzed 2019-09-25 16:33 UTC

↳ Parent: CacheItem

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * Created by Fernando Robledo <[email protected]>.
 */

namespace Overdesign\PsrCache;

use DateInterval;
use DateTime;
use DateTimeInterface;
use Psr\Cache\CacheItemInterface;

class CacheItem implements CacheItemInterface
{
    /** @var string */
    protected $key;
    /** @var bool */
    protected $isHit;
    /** @var mixed */
    protected $data;
    /** @var DateTime */
    protected $expiresAt;


    public function __construct($key, $data = null, $isHit = false)
    {
        $this->key       = $key;
        $this->data      = $data;
        $this->isHit     = $isHit;
        $this->expiresAt = null;
    }

    /**
     * @return bool
     */
    private function isExpired()
    {
        if ($this->expiresAt === null) {
            return false;
        }

        $now = new DateTime();

        return $now > $this->expiresAt;
    }

    /**
     * Returns the key for the current cache item.
     *
     * The key is loaded by the Implementing Library, but should be available to
     * the higher level callers when needed.
     *
     * @return string
     *   The key string for this cache item.
     */
    public function getKey()
    {
        return $this->key;
    }

    /**
     * Retrieves the value of the item from the cache associated with this object's key.
     *
     * The value returned must be identical to the value originally stored by set().
     *
     * If isHit() returns false, this method MUST return null. Note that null
     * is a legitimate cached value, so the isHit() method SHOULD be used to
     * differentiate between "null value was found" and "no value was found."
     *
     * @return mixed
     *   The value corresponding to this cache item's key, or null if not found.
     */
    public function get()
    {
        return $this->isHit() ? $this->data : null;
    }

    /**
     * Confirms if the cache item lookup resulted in a cache hit.
     *
     * Note: This method MUST NOT have a race condition between calling isHit()
     * and calling get().
     *
     * @return bool
     *   True if the request resulted in a cache hit. False otherwise.
     */
    public function isHit()
    {
        return $this->isHit && !$this->isExpired();
    }

    /**
     * Sets the value represented by this cache item.
     *
     * The $value argument may be any item that can be serialized by PHP,
     * although the method of serialization is left up to the Implementing
     * Library.
     *
     * @param mixed $value
     *   The serializable value to be stored.
     *
     * @return static
     *   The invoked object.
     */
    public function set($value)
    {
        $this->data  = $value;
        $this->isHit = true;

        return $this;
    }

    /**
     * Sets the expiration time for this cache item.
     *
     * @param DateTimeInterface|null $expiration
     *   The point in time after which the item MUST be considered expired.
     *   If null is passed explicitly, a default value MAY be used. If none is set,
     *   the value should be stored permanently or for as long as the
     *   implementation allows.
     *
     * @return static
     *   The called object.
     */
    public function expiresAt($expiration)
    {
        if ($expiration === null ||
            $expiration instanceof DateTime || // php < 5.5
            $expiration instanceof DateTimeInterface) {

            $this->expiresAt = $expiration;
        }

        return $this;
    }

    /**
     * Sets the expiration time for this cache item.
     *
     * @param int|\DateInterval|null $time
     *   The period of time from the present after which the item MUST be considered
     *   expired. An integer parameter is understood to be the time in seconds until
     *   expiration. If null is passed explicitly, a default value MAY be used.
     *   If none is set, the value should be stored permanently or for as long as the
     *   implementation allows.
     *
     * @return static
     *   The called object.
     */
    public function expiresAfter($time)
    {
        if ($time === null) {
            $this->expiresAt = $time;
            return $this;
        }

        $now  = new DateTime();
        $time = ($time instanceof DateInterval) ? $time : new DateInterval('PT' . $time . 'S');

        $this->expiresAt = $now->add($time);

        return $this;
    }

    /**
     * Updates isHit status when unserializing
     */
    public function __wakeup()
    {
        $this->isHit = !$this->isExpired();
    }
}


1			<?php
2
3			/*
4			* Created by Fernando Robledo <[email protected]>.
5			*/
6
7			namespace Overdesign\PsrCache;
8
9			use DateInterval;
10			use DateTime;
11			use DateTimeInterface;
12			use Psr\Cache\CacheItemInterface;
13
14			class CacheItem implements CacheItemInterface
15			{
16			/** @var string */
17			protected $key;
18			/** @var bool */
19			protected $isHit;
20			/** @var mixed */
21			protected $data;
22			/** @var DateTime */
23			protected $expiresAt;
24
25
26			public function __construct($key, $data = null, $isHit = false)
27			{
28			$this->key = $key;
29			$this->data = $data;
30			$this->isHit = $isHit;
31			$this->expiresAt = null;
32			}
33
34			/**
35			* @return bool
36			*/
37			private function isExpired()
38			{
39			if ($this->expiresAt === null) {
40			return false;
41			}
42
43			$now = new DateTime();
44
45			return $now > $this->expiresAt;
46			}
47
48			/**
49			* Returns the key for the current cache item.
50			*
51			* The key is loaded by the Implementing Library, but should be available to
52			* the higher level callers when needed.
53			*
54			* @return string
55			* The key string for this cache item.
56			*/
57			public function getKey()
58			{
59			return $this->key;
60			}
61
62			/**
63			* Retrieves the value of the item from the cache associated with this object's key.
64			*
65			* The value returned must be identical to the value originally stored by set().
66			*
67			* If isHit() returns false, this method MUST return null. Note that null
68			* is a legitimate cached value, so the isHit() method SHOULD be used to
69			* differentiate between "null value was found" and "no value was found."
70			*
71			* @return mixed
72			* The value corresponding to this cache item's key, or null if not found.
73			*/
74			public function get()
75			{
76			return $this->isHit() ? $this->data : null;
77			}
78
79			/**
80			* Confirms if the cache item lookup resulted in a cache hit.
81			*
82			* Note: This method MUST NOT have a race condition between calling isHit()
83			* and calling get().
84			*
85			* @return bool
86			* True if the request resulted in a cache hit. False otherwise.
87			*/
88			public function isHit()
89			{
90			return $this->isHit && !$this->isExpired();
91			}
92
93			/**
94			* Sets the value represented by this cache item.
95			*
96			* The $value argument may be any item that can be serialized by PHP,
97			* although the method of serialization is left up to the Implementing
98			* Library.
99			*
100			* @param mixed $value
101			* The serializable value to be stored.
102			*
103			* @return static
104			* The invoked object.
105			*/
106			public function set($value)
107			{
108			$this->data = $value;
109			$this->isHit = true;
110
111			return $this;
112			}
113
114			/**
115			* Sets the expiration time for this cache item.
116			*
117			* @param DateTimeInterface\|null $expiration
118			* The point in time after which the item MUST be considered expired.
119			* If null is passed explicitly, a default value MAY be used. If none is set,
120			* the value should be stored permanently or for as long as the
121			* implementation allows.
122			*
123			* @return static
124			* The called object.
125			*/
126			public function expiresAt($expiration)
127			{
128			if ($expiration === null \|\|
129			$expiration instanceof DateTime \|\| // php < 5.5
130			$expiration instanceof DateTimeInterface) {
			0 ignored issues – show introduced 2019-05-09 18:20 UTC by Report Bug Copy Issue Report `$expiration` is always a sub-type of `DateTimeInterface`. Loading history...
131			$this->expiresAt = $expiration;
132			}
133
134			return $this;
135			}
136
137			/**
138			* Sets the expiration time for this cache item.
139			*
140			* @param int\|\DateInterval\|null $time
141			* The period of time from the present after which the item MUST be considered
142			* expired. An integer parameter is understood to be the time in seconds until
143			* expiration. If null is passed explicitly, a default value MAY be used.
144			* If none is set, the value should be stored permanently or for as long as the
145			* implementation allows.
146			*
147			* @return static
148			* The called object.
149			*/
150			public function expiresAfter($time)
151			{
152			if ($time === null) {
153			$this->expiresAt = $time;
154			return $this;
155			}
156
157			$now = new DateTime();
158			$time = ($time instanceof DateInterval) ? $time : new DateInterval('PT' . $time . 'S');
159
160			$this->expiresAt = $now->add($time);
161
162			return $this;
163			}
164
165			/**
166			* Updates isHit status when unserializing
167			*/
168			public function __wakeup()
169			{
170			$this->isHit = !$this->isExpired();
171			}
172			}
173

override2k / psr-cache

CacheItem::getKey() A last analyzed 2019-09-25 16:33 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CacheItem::getKey() A
last analyzed 2019-09-25 16:33 UTC