Laravel5::get() - Code Metrics - Inspection of "Use cache adapter from base package" - aimeos/ai-laravel - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b198de...660cb3 )

by Aimeos

created 2022-03-20 10:11 UTC

Laravel5::get() A

↳ Parent: Laravel5

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2015-2022
 * @package MW
 * @subpackage Cache
 */


namespace Aimeos\Base\Cache;


/**
 * Laravel 5 caching implementation.
 *
 * @package MW
 * @subpackage Cache
 */
class Laravel5
	extends \Aimeos\Base\Cache\Base
	implements \Aimeos\Base\Cache\Iface
{
	private $object;


	/**
	 * Initializes the object instance.
	 *
	 * @param \Illuminate\Contracts\Cache\Store $cache Laravel cache object
	 */
	public function __construct( \Illuminate\Contracts\Cache\Store $cache )
	{
		$this->object = $cache;
	}


	/**
	 * Removes all entries from the cache so it's completely empty.
	 *
	 * @inheritDoc
	 *
	 * This method deletes all cached entries from the cache server the client
	 * has access to. This method is primarily usefull to provide a clean start
	 * before new entries are added to the cache and you don't know which
	 * entries are still in the cache.
	 *
	 * @return bool True on success and false on failure
	 */
	public function clear() : bool
	{
		return $this->object->flush();
	}


	/**
	 * Removes the cache entry identified by the given key.
	 *
	 * @inheritDoc
	 *
	 * @param string $key Key string that identifies the single cache entry
	 * @return bool True if the item was successfully removed. False if there was an error
	 * @throws \Psr\SimpleCache\InvalidArgumentException
	 */
	public function delete( string $key ) : bool
	{
		return $this->object->forget( $key );
	}


	/**
	 * Removes the cache entries identified by the given keys.
	 *
	 * @inheritDoc
	 *
	 * @param iterable $keys List of key strings that identify the cache entries that should be removed
	 * @return bool True if the items were successfully removed. False if there was an error.
	 * @throws \Psr\SimpleCache\InvalidArgumentException
	 */
	public function deleteMultiple( iterable $keys ) : bool
	{
		foreach( $keys as $key ) {
			$this->object->forget( $key );
		}

		return true;
	}


	/**
	 * Removes the cache entries identified by the given tags.
	 *
	 * @inheritDoc
	 *
	 * @param iterable $tags List of tag strings that are associated to one or more cache entries that should be removed
	 * @return bool True if the items were successfully removed. False if there was an error.
	 * @throws \Psr\SimpleCache\InvalidArgumentException
	 */
	public function deleteByTags( iterable $tags ) : bool
	{
		return $this->object->flush();
	}


	/**
	 * Returns the value of the requested cache key.
	 *
	 * @inheritDoc
	 *
	 * @param string $key Path to the requested value like product/id/123
	 * @param mixed $default Value returned if requested key isn't found
	 * @return mixed Value associated to the requested key. If no value for the
	 *	key is found in the cache, the given default value is returned
	 * @throws \Psr\SimpleCache\InvalidArgumentException
	 */
	public function get( string $key, $default = null )
	{
		if( ( $entry = $this->object->get( $key ) ) !== null ) {
			return $entry;
		}

		return $default;
	}


	/**
	 * Returns the cached values for the given cache keys.
	 *
	 * @inheritDoc
	 *
	 * @param iterable $keys List of key strings for the requested cache entries
	 * @param mixed $default Default value to return for keys that do not exist
	 * @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
	 * @throws \Psr\SimpleCache\InvalidArgumentException
	 */
	public function getMultiple( iterable $keys, $default = null ) : iterable
	{
		$result = [];

		foreach( $keys as $key )
		{
			if( ( $entry = $this->object->get( $key ) ) !== false ) {
				$result[$key] = $entry;
			} else {
				$result[$key] = $default;
			}
		}

		return $result;
	}


	/**
	 * Determines whether an item is present in the cache.
	 *
	 * @inheritDoc
	 *
	 * @param string $key The cache item key
	 * @return bool True if cache entry is available, false if not
	 * @throws \Psr\SimpleCache\InvalidArgumentException
	 */
	public function has( string $key ) : bool
	{
		if( $this->object->get( $key ) !== null ) {
			return true;
		}

		return false;
	}


	/**
	 * Sets the value for the specified key.
	 *
	 * @inheritDoc
	 *
	 * @param string $key Key string for the given value like product/id/123
	 * @param mixed $value Value string that should be stored for the given key
	 * @param \DateInterval|int|string|null $expires Date interval object,
	 *  date/time string in "YYYY-MM-DD HH:mm:ss" format or as integer TTL value
	 *  when the cache entry will expiry
	 * @param iterable $tags List of tag strings that should be assoicated to the cache entry
	 * @return bool True on success and false on failure.
	 * @throws \Psr\SimpleCache\InvalidArgumentException
	 */
	public function set( string $key, $value, $expires = null, iterable $tags = [] ) : bool
	{
		if( $expires instanceof \DateInterval ) {
			return $this->object->put( $key, $value, (int) ( date_create()->add( $expires )->format( 'Y-m-d H:i:s' ) - time() ) );
		} elseif( is_string( $expires ) ) {
			return $this->object->put( $key, $value, (int) ( date_create( $expires )->getTimestamp() - time() ) );
		} elseif( is_int( $expires ) ) {
			return $this->object->put( $key, $value, (int) $expires );
		} else {
			return $this->object->forever( $key, $value );
		}
	}


	/**
	 * Adds the given key/value pairs to the cache.
	 *
	 * @inheritDoc
	 *
	 * @param iterable $pairs Associative list of key/value pairs. Both must be a string
	 * @param \DateInterval|int|string|null $expires Date interval object,
	 *  date/time string in "YYYY-MM-DD HH:mm:ss" format or as integer TTL value
	 *  when the cache entry will expiry
	 * @param iterable $tags List of tags that should be associated to the cache entries
	 * @return bool True on success and false on failure.
	 * @throws \Psr\SimpleCache\InvalidArgumentException
	 */
	public function setMultiple( iterable $pairs, $expires = null, iterable $tags = [] ) : bool
	{
		foreach( $pairs as $key => $value ) {
			$this->set( $key, $value, $expires, $tags );
		}

		return true;
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2015-2022
6			* @package MW
7			* @subpackage Cache
8			*/
9
10
11			namespace Aimeos\Base\Cache;
12
13
14			/**
15			* Laravel 5 caching implementation.
16			*
17			* @package MW
18			* @subpackage Cache
19			*/
20			class Laravel5
21			extends \Aimeos\Base\Cache\Base
22			implements \Aimeos\Base\Cache\Iface
23			{
24			private $object;
25
26
27			/**
28			* Initializes the object instance.
29			*
30			* @param \Illuminate\Contracts\Cache\Store $cache Laravel cache object
31			*/
32			public function __construct( \Illuminate\Contracts\Cache\Store $cache )
33			{
34			$this->object = $cache;
35			}
36
37
38			/**
39			* Removes all entries from the cache so it's completely empty.
40			*
41			* @inheritDoc
42			*
43			* This method deletes all cached entries from the cache server the client
44			* has access to. This method is primarily usefull to provide a clean start
45			* before new entries are added to the cache and you don't know which
46			* entries are still in the cache.
47			*
48			* @return bool True on success and false on failure
49			*/
50			public function clear() : bool
51			{
52			return $this->object->flush();
53			}
54
55
56			/**
57			* Removes the cache entry identified by the given key.
58			*
59			* @inheritDoc
60			*
61			* @param string $key Key string that identifies the single cache entry
62			* @return bool True if the item was successfully removed. False if there was an error
63			* @throws \Psr\SimpleCache\InvalidArgumentException
64			*/
65			public function delete( string $key ) : bool
66			{
67			return $this->object->forget( $key );
68			}
69
70
71			/**
72			* Removes the cache entries identified by the given keys.
73			*
74			* @inheritDoc
75			*
76			* @param iterable $keys List of key strings that identify the cache entries that should be removed
77			* @return bool True if the items were successfully removed. False if there was an error.
78			* @throws \Psr\SimpleCache\InvalidArgumentException
79			*/
80			public function deleteMultiple( iterable $keys ) : bool
81			{
82			foreach( $keys as $key ) {
83			$this->object->forget( $key );
84			}
85
86			return true;
87			}
88
89
90			/**
91			* Removes the cache entries identified by the given tags.
92			*
93			* @inheritDoc
94			*
95			* @param iterable $tags List of tag strings that are associated to one or more cache entries that should be removed
96			* @return bool True if the items were successfully removed. False if there was an error.
97			* @throws \Psr\SimpleCache\InvalidArgumentException
98			*/
99			public function deleteByTags( iterable $tags ) : bool
100			{
101			return $this->object->flush();
102			}
103
104
105			/**
106			* Returns the value of the requested cache key.
107			*
108			* @inheritDoc
109			*
110			* @param string $key Path to the requested value like product/id/123
111			* @param mixed $default Value returned if requested key isn't found
112			* @return mixed Value associated to the requested key. If no value for the
113			* key is found in the cache, the given default value is returned
114			* @throws \Psr\SimpleCache\InvalidArgumentException
115			*/
116			public function get( string $key, $default = null )
117			{
118			if( ( $entry = $this->object->get( $key ) ) !== null ) {
119			return $entry;
120			}
121
122			return $default;
123			}
124
125
126			/**
127			* Returns the cached values for the given cache keys.
128			*
129			* @inheritDoc
130			*
131			* @param iterable $keys List of key strings for the requested cache entries
132			* @param mixed $default Default value to return for keys that do not exist
133			* @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
134			* @throws \Psr\SimpleCache\InvalidArgumentException
135			*/
136			public function getMultiple( iterable $keys, $default = null ) : iterable
137			{
138			$result = [];
139
140			foreach( $keys as $key )
141			{
142			if( ( $entry = $this->object->get( $key ) ) !== false ) {
143			$result[$key] = $entry;
144			} else {
145			$result[$key] = $default;
146			}
147			}
148
149			return $result;
150			}
151
152
153			/**
154			* Determines whether an item is present in the cache.
155			*
156			* @inheritDoc
157			*
158			* @param string $key The cache item key
159			* @return bool True if cache entry is available, false if not
160			* @throws \Psr\SimpleCache\InvalidArgumentException
161			*/
162			public function has( string $key ) : bool
163			{
164			if( $this->object->get( $key ) !== null ) {
165			return true;
166			}
167
168			return false;
169			}
170
171
172			/**
173			* Sets the value for the specified key.
174			*
175			* @inheritDoc
176			*
177			* @param string $key Key string for the given value like product/id/123
178			* @param mixed $value Value string that should be stored for the given key
179			* @param \DateInterval\|int\|string\|null $expires Date interval object,
180			* date/time string in "YYYY-MM-DD HH:mm:ss" format or as integer TTL value
181			* when the cache entry will expiry
182			* @param iterable $tags List of tag strings that should be assoicated to the cache entry
183			* @return bool True on success and false on failure.
184			* @throws \Psr\SimpleCache\InvalidArgumentException
185			*/
186			public function set( string $key, $value, $expires = null, iterable $tags = [] ) : bool
187			{
188			if( $expires instanceof \DateInterval ) {
189			return $this->object->put( $key, $value, (int) ( date_create()->add( $expires )->format( 'Y-m-d H:i:s' ) - time() ) );
190			} elseif( is_string( $expires ) ) {
191			return $this->object->put( $key, $value, (int) ( date_create( $expires )->getTimestamp() - time() ) );
192			} elseif( is_int( $expires ) ) {
193			return $this->object->put( $key, $value, (int) $expires );
194			} else {
195			return $this->object->forever( $key, $value );
196			}
197			}
198
199
200			/**
201			* Adds the given key/value pairs to the cache.
202			*
203			* @inheritDoc
204			*
205			* @param iterable $pairs Associative list of key/value pairs. Both must be a string
206			* @param \DateInterval\|int\|string\|null $expires Date interval object,
207			* date/time string in "YYYY-MM-DD HH:mm:ss" format or as integer TTL value
208			* when the cache entry will expiry
209			* @param iterable $tags List of tags that should be associated to the cache entries
210			* @return bool True on success and false on failure.
211			* @throws \Psr\SimpleCache\InvalidArgumentException
212			*/
213			public function setMultiple( iterable $pairs, $expires = null, iterable $tags = [] ) : bool
214			{
215			foreach( $pairs as $key => $value ) {
216			$this->set( $key, $value, $expires, $tags );
217			}
218
219			return true;
220			}
221			}
222

aimeos / ai-laravel

Push — master ( b198de...660cb3 )

Laravel5::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like