Item::__construct() - Code Metrics - Inspection of "Implement type check per errata to PSR-6" - joomla-framework/cache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.0-dev ( 05b98e...923a4b )

by Michael

created 2018-04-05 23:22 UTC

Item::__construct() A

↳ Parent: Item

Complexity

Conditions	4
Paths	3

Size

Total Lines	17
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	4.25

Importance

Changes

Metric	Value
dl	0
loc	17
ccs	6
cts	8
cp	0.75
rs	9.2
c	0
b	0
f	0
cc	4
eloc	8
nc	3
nop	2
crap	4.25

<?php
/**
 * Part of the Joomla Framework Cache Package
 *
 * @copyright  Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
 * @license    GNU General Public License version 2 or later; see LICENSE
 */

namespace Joomla\Cache\Item;

use Joomla\Cache\Exception\InvalidArgumentException;

/**
 * Cache item instance for the Joomla Framework.
 *
 * @since  1.0
 */
class Item extends AbstractItem
{
	/**
	 * The time the object expires at
	 *
	 * @var    \DateTimeInterface
	 * @since  __DEPLOY_VERSION__
	 */
	private $expiration;

	/**
	 * The key for the cache item.
	 *
	 * @var    string
	 * @since  1.0
	 */
	private $key;

	/**
	 * The value of the cache item.
	 *
	 * @var    mixed
	 * @since  1.0
	 */
	private $value;

	/**
	 * Whether the cache item has been hit.
	 *
	 * @var    boolean
	 * @since  1.0
	 */
	private $hit = false;

	/**
	 * Class constructor.
	 *
	 * @param   string                                         $key  The key for the cache item.
	 * @param   \DateInterval|\DateTimeInterface|integer|null  $ttl  The expiry time for the cache item in seconds or as a datetime object
	 *
	 * @since   1.0
	 */
	public function __construct($key, $ttl = null)
	{
		$this->key = $key;

		if (is_int($ttl) || ($ttl instanceof \DateInterval))
		{
			$this->expiresAfter($ttl);
		}
		elseif ($ttl instanceof \DateTimeInterface)
		{
			$this->expiresAt($ttl);
		}
		else
		{
			$this->expiresAfter(900);
		}
	}

	/**
	 * Confirms if the cache item exists in the cache.
	 *
	 * Note: This method MAY avoid retrieving the cached value for performance
	 * reasons, which could result in a race condition between exists() and get().
	 * To avoid that potential race condition use isHit() instead.
	 *
	 * @return  boolean
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function exists()
	{
		return $this->isHit();
	}

	/**
	 * Returns the key for the current cache item.
	 *
	 * @return  string  The key string for this cache item.
	 *
	 * @since   1.0
	 */
	public function getKey()
	{
		return $this->key;
	}

	/**
	 * Retrieves the value of the item from the cache associated with this object's key.
	 *
	 * @return  mixed  The value corresponding to this cache item's key, or null if not found.
	 *
	 * @since   1.0
	 */
	public function get()
	{
		return $this->value;
	}

	/**
	 * Sets the value represented by this cache item.
	 *
	 * If the value is set, we are assuming that there was a valid hit on the cache for the given key.
	 *
	 * @param   mixed  $value  The serializable value to be stored.
	 *
	 * @return  $this
	 *
	 * @since   1.0
	 */
	public function set($value)
	{
		$this->value = $value;
		$this->hit = true;

		return $this;
	}

	/**
	 * Confirms if the cache item lookup resulted in a cache hit.
	 *
	 * @return  boolean  True if the request resulted in a cache hit. False otherwise.
	 *
	 * @since   1.0
	 */
	public function isHit()
	{
		return $this->hit;
	}

	/**
	 * 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  $this
	 *
	 * @since   __DEPLOY_VERSION__
	 * @throws  InvalidArgumentException
	 */
	public function expiresAt($expiration)
	{
		if ($expiration !== null && !($expiration instanceof \DateTimeInterface))
		{
			throw new InvalidArgumentException(
				sprintf(
					'Argument 1 passed to %s::expiresAt() must be an instance of DateTimeInterface; %s given',
					get_class($this),
					is_object($expiration) ? get_class($expiration) : gettype($expiration)
				)
			);
		}

		$this->expiration = $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.
	 *
	 * @return  $this
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function expiresAfter($time)
	{
		if (is_integer($time))
		{
			$this->expiration = new \DateTime('now +' . $time . ' seconds');
		}
		elseif ($time instanceof \DateInterval)
		{
			$this->expiration = new \DateTime('now');
			$this->expiration->add($time);
		}
		else
		{
			$this->expiration = new \DateTime('now + 900 seconds');
		}

		return $this;
	}

	/**
	 * Returns the expiration time of a not-yet-expired cache item.
	 *
	 * If this cache item is a Cache Miss, this method MAY return the time at which the item expired or the current time if that is not available.
	 *
	 * @return  \DateTimeInterface  The timestamp at which this cache item will expire.
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function getExpiration(): \DateTimeInterface
	{
		return $this->expiration;
	}
}


1		<?php
2		/**
3		* Part of the Joomla Framework Cache Package
4		*
5		* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
6		* @license GNU General Public License version 2 or later; see LICENSE
7		*/
8
9		namespace Joomla\Cache\Item;
10
11		use Joomla\Cache\Exception\InvalidArgumentException;
12
13		/**
14		* Cache item instance for the Joomla Framework.
15		*
16		* @since 1.0
17		*/
18		class Item extends AbstractItem
19		{
20		/**
21		* The time the object expires at
22		*
23		* @var \DateTimeInterface
24		* @since __DEPLOY_VERSION__
25		*/
26		private $expiration;
27
28		/**
29		* The key for the cache item.
30		*
31		* @var string
32		* @since 1.0
33		*/
34		private $key;
35
36		/**
37		* The value of the cache item.
38		*
39		* @var mixed
40		* @since 1.0
41		*/
42		private $value;
43
44		/**
45		* Whether the cache item has been hit.
46		*
47		* @var boolean
48		* @since 1.0
49		*/
50		private $hit = false;
51
52		/**
53		* Class constructor.
54		*
55		* @param string $key The key for the cache item.
56		* @param \DateInterval\|\DateTimeInterface\|integer\|null $ttl The expiry time for the cache item in seconds or as a datetime object
57		*
58		* @since 1.0
59		*/
60	54	public function __construct($key, $ttl = null)
61		{
62	54	$this->key = $key;
63
64	54	if (is_int($ttl) \|\| ($ttl instanceof \DateInterval))
65		{
66		$this->expiresAfter($ttl);
67		}
68	54	elseif ($ttl instanceof \DateTimeInterface)
69		{
70		$this->expiresAt($ttl);
71		}
72		else
73		{
74	54	$this->expiresAfter(900);
75		}
76	54	}
77
78		/**
79		* Confirms if the cache item exists in the cache.
80		*
81		* Note: This method MAY avoid retrieving the cached value for performance
82		* reasons, which could result in a race condition between exists() and get().
83		* To avoid that potential race condition use isHit() instead.
84		*
85		* @return boolean
86		*
87		* @since __DEPLOY_VERSION__
88		*/
89		public function exists()
90		{
91		return $this->isHit();
92		}
93
94		/**
95		* Returns the key for the current cache item.
96		*
97		* @return string The key string for this cache item.
98		*
99		* @since 1.0
100		*/
101	39	public function getKey()
102		{
103	39	return $this->key;
104		}
105
106		/**
107		* Retrieves the value of the item from the cache associated with this object's key.
108		*
109		* @return mixed The value corresponding to this cache item's key, or null if not found.
110		*
111		* @since 1.0
112		*/
113	41	public function get()
114		{
115	41	return $this->value;
116		}
117
118		/**
119		* Sets the value represented by this cache item.
120		*
121		* If the value is set, we are assuming that there was a valid hit on the cache for the given key.
122		*
123		* @param mixed $value The serializable value to be stored.
124		*
125		* @return $this
126		*
127		* @since 1.0
128		*/
129	49	public function set($value)
130		{
131	49	$this->value = $value;
132	49	$this->hit = true;
133
134	49	return $this;
135		}
136
137		/**
138		* Confirms if the cache item lookup resulted in a cache hit.
139		*
140		* @return boolean True if the request resulted in a cache hit. False otherwise.
141		*
142		* @since 1.0
143		*/
144	33	public function isHit()
145		{
146	33	return $this->hit;
147		}
148
149		/**
150		* Sets the expiration time for this cache item.
151		*
152		* @param \DateTimeInterface\|null $expiration The point in time after which the item MUST be considered expired.
153		* If null is passed explicitly, a default value MAY be used. If none is
154		* set, the value should be stored permanently or for as long as the
155		* implementation allows.
156		*
157		* @return $this
158		*
159		* @since __DEPLOY_VERSION__
160		* @throws InvalidArgumentException
161		*/
162		public function expiresAt($expiration)
163		{
164		if ($expiration !== null && !($expiration instanceof \DateTimeInterface))
165		{
166		throw new InvalidArgumentException(
167		sprintf(
168		'Argument 1 passed to %s::expiresAt() must be an instance of DateTimeInterface; %s given',
169		get_class($this),
170		is_object($expiration) ? get_class($expiration) : gettype($expiration)
171		)
172		);
173		}
174
175		$this->expiration = $expiration;
176
177		return $this;
178		}
179
180		/**
181		* Sets the expiration time for this cache item.
182		*
183		* @param int\|\DateInterval\|null $time The period of time from the present after which the item MUST be considered
184		* expired. An integer parameter is understood to be the time in seconds until
185		* expiration.
186		*
187		* @return $this
188		*
189		* @since __DEPLOY_VERSION__
190		*/
191	54	public function expiresAfter($time)
192		{
193	54	if (is_integer($time))
194		{
195	54	$this->expiration = new \DateTime('now +' . $time . ' seconds');
196		}
197	31	elseif ($time instanceof \DateInterval)
198		{
199		$this->expiration = new \DateTime('now');
200		$this->expiration->add($time);
201		}
202		else
203		{
204	31	$this->expiration = new \DateTime('now + 900 seconds');
205		}
206
207	54	return $this;
208		}
209
210		/**
211		* Returns the expiration time of a not-yet-expired cache item.
212		*
213		* If this cache item is a Cache Miss, this method MAY return the time at which the item expired or the current time if that is not available.
214		*
215		* @return \DateTimeInterface The timestamp at which this cache item will expire.
216		*
217		* @since __DEPLOY_VERSION__
218		*/
219	21	public function getExpiration(): \DateTimeInterface
220		{
221	21	return $this->expiration;
222		}
223		}
224

joomla-framework / cache

Push — 2.0-dev ( 05b98e...923a4b )

Item::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like