NoCacheAdapter::commit() - Code Metrics - Inspection of "Add parameter bag" - Sf4/Api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ae14df...9d195a )

by Siim

created 2019-04-03 06:48 UTC

NoCacheAdapter::commit() A

↳ Parent: NoCacheAdapter

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
/**
 * Created by PhpStorm.
 * User: john
 * Date: 1.04.19
 * Time: 8:36
 */

namespace Sf4\Api\Services;

use Psr\Cache\CacheItemInterface;
use Psr\Cache\InvalidArgumentException;
use Symfony\Contracts\Cache\CallbackInterface;
use Symfony\Contracts\Cache\ItemInterface;

class NoCacheAdapter implements CacheAdapterInterface
{

    /**
     * Returns a Cache Item representing the specified key.
     *
     * This method must always return a ItemInterface object, even in case of
     * a cache miss. It MUST NOT return null.
     *
     * @param string $key
     *   The key for which to return the corresponding Cache Item.
     *
     * @throws InvalidArgumentException
     *   If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException
     *   MUST be thrown.
     *
     * @return ItemInterface
     *   The corresponding Cache Item.
     */
    public function getItem($key): ?ItemInterface
    {
        return null;
    }

    /**
     * Returns a traversable set of cache items.
     *
     * @param string[] $keys
     *   An indexed array of keys of items to retrieve.
     *
     * @throws InvalidArgumentException
     *   If any of the keys in $keys are not a legal value a \Psr\Cache\InvalidArgumentException
     *   MUST be thrown.
     *
     * @return array|\Traversable
     *   A traversable collection of Cache Items keyed by the cache keys of
     *   each item. A Cache item will be returned for each key, even if that
     *   key is not found. However, if no keys are specified then an empty
     *   traversable MUST be returned instead.
     */
    public function getItems(array $keys = array())
    {
        return [];
    }

    /**
     * Confirms if the cache contains specified cache item.
     *
     * Note: This method MAY avoid retrieving the cached value for performance reasons.
     * This could result in a race condition with ItemInterface::get(). To avoid
     * such situation use ItemInterface::isHit() instead.
     *
     * @param string $key
     *   The key for which to check existence.
     *
     * @throws InvalidArgumentException
     *   If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException
     *   MUST be thrown.
     *
     * @return bool
     *   True if item exists in the cache, false otherwise.
     */
    public function hasItem($key): bool
    {
        return false;
    }

    /**
     * Deletes all items in the pool.
     *
     * @return bool
     *   True if the pool was successfully cleared. False if there was an error.
     */
    public function clear(): bool
    {
        return true;
    }

    /**
     * Removes the item from the pool.
     *
     * @param string $key
     *   The key to delete.
     *
     * @throws InvalidArgumentException
     *   If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException
     *   MUST be thrown.
     *
     * @return bool
     *   True if the item was successfully removed. False if there was an error.
     */
    public function deleteItem($key): bool
    {
        return true;
    }

    /**
     * Removes multiple items from the pool.
     *
     * @param string[] $keys
     *   An array of keys that should be removed from the pool.
     * @throws InvalidArgumentException
     *   If any of the keys in $keys are not a legal value a \Psr\Cache\InvalidArgumentException
     *   MUST be thrown.
     *
     * @return bool
     *   True if the items were successfully removed. False if there was an error.
     */
    public function deleteItems(array $keys): bool
    {
        return true;
    }

    /**
     * Persists a cache item immediately.
     *
     * @param CacheItemInterface $item
     *   The cache item to save.
     *
     * @return bool
     *   True if the item was successfully persisted. False if there was an error.
     */
    public function save(CacheItemInterface $item): bool
    {
        return true;
    }

    /**
     * Sets a cache item to be persisted later.
     *
     * @param CacheItemInterface $item
     *   The cache item to save.
     *
     * @return bool
     *   False if the item could not be queued or if a commit was attempted and failed. True otherwise.
     */
    public function saveDeferred(CacheItemInterface $item): bool
    {
        return true;
    }

    /**
     * Persists any deferred cache items.
     *
     * @return bool
     *   True if all not-yet-saved items were successfully saved or there were none. False otherwise.
     */
    public function commit(): bool
    {
        return true;
    }

    /**
     * Fetches a value from the pool or computes it if not found.
     *
     * On cache misses, a callback is called that should return the missing value.
     * This callback is given a PSR-6 ItemInterface instance corresponding to the
     * requested key, that could be used e.g. for expiration control. It could also
     * be an ItemInterface instance when its additional features are needed.
     *
     * @param string $key The key of the item to retrieve from the cache
     * @param callable|CallbackInterface $callback Should return the computed value for the given key/item
     * @param float|null $beta A float that, as it grows, controls the likeliness of triggering
     *        early expiration. 0 disables it, INF forces immediate expiration.
     *        The default (or providing null) is implementation dependent but should
     *        typically be 1.0, which should provide optimal stampede protection.
     *        See https://en.wikipedia.org/wiki/Cache_stampede#Probabilistic_early_expiration
     * @param array &$metadata The metadata of the cached item {@see ItemInterface::getMetadata()}
     *
     * @return mixed The value corresponding to the provided key
     *
     * @throws InvalidArgumentException When $key is not valid or when $beta is negative
     */
    public function get(string $key, callable $callback, float $beta = null, array &$metadata = null)
    {
        return null;
    }

    /**
     * Removes an item from the pool.
     *
     * @param string $key The key to delete
     *
     * @throws InvalidArgumentException When $key is not valid
     *
     * @return bool True if the item was successfully removed, false if there was any error
     */
    public function delete(string $key): bool
    {
        return true;
    }

    /**
     * Invalidates cached items using tags.
     *
     * @param string[] $tags An array of tags to invalidate
     *
     * @return bool True on success
     */
    public function invalidateTags(array $tags): bool
    {
        return true;
    }
}


1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: john
5			* Date: 1.04.19
6			* Time: 8:36
7			*/
8
9			namespace Sf4\Api\Services;
10
11			use Psr\Cache\CacheItemInterface;
12			use Psr\Cache\InvalidArgumentException;
13			use Symfony\Contracts\Cache\CallbackInterface;
14			use Symfony\Contracts\Cache\ItemInterface;
15
16			class NoCacheAdapter implements CacheAdapterInterface
17			{
18
19			/**
20			* Returns a Cache Item representing the specified key.
21			*
22			* This method must always return a ItemInterface object, even in case of
23			* a cache miss. It MUST NOT return null.
24			*
25			* @param string $key
26			* The key for which to return the corresponding Cache Item.
27			*
28			* @throws InvalidArgumentException
29			* If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException
30			* MUST be thrown.
31			*
32			* @return ItemInterface
33			* The corresponding Cache Item.
34			*/
35			public function getItem($key): ?ItemInterface
36			{
37			return null;
38			}
39
40			/**
41			* Returns a traversable set of cache items.
42			*
43			* @param string[] $keys
44			* An indexed array of keys of items to retrieve.
45			*
46			* @throws InvalidArgumentException
47			* If any of the keys in $keys are not a legal value a \Psr\Cache\InvalidArgumentException
48			* MUST be thrown.
49			*
50			* @return array\|\Traversable
51			* A traversable collection of Cache Items keyed by the cache keys of
52			* each item. A Cache item will be returned for each key, even if that
53			* key is not found. However, if no keys are specified then an empty
54			* traversable MUST be returned instead.
55			*/
56			public function getItems(array $keys = array())
57			{
58			return [];
59			}
60
61			/**
62			* Confirms if the cache contains specified cache item.
63			*
64			* Note: This method MAY avoid retrieving the cached value for performance reasons.
65			* This could result in a race condition with ItemInterface::get(). To avoid
66			* such situation use ItemInterface::isHit() instead.
67			*
68			* @param string $key
69			* The key for which to check existence.
70			*
71			* @throws InvalidArgumentException
72			* If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException
73			* MUST be thrown.
74			*
75			* @return bool
76			* True if item exists in the cache, false otherwise.
77			*/
78			public function hasItem($key): bool
79			{
80			return false;
81			}
82
83			/**
84			* Deletes all items in the pool.
85			*
86			* @return bool
87			* True if the pool was successfully cleared. False if there was an error.
88			*/
89			public function clear(): bool
90			{
91			return true;
92			}
93
94			/**
95			* Removes the item from the pool.
96			*
97			* @param string $key
98			* The key to delete.
99			*
100			* @throws InvalidArgumentException
101			* If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException
102			* MUST be thrown.
103			*
104			* @return bool
105			* True if the item was successfully removed. False if there was an error.
106			*/
107			public function deleteItem($key): bool
108			{
109			return true;
110			}
111
112			/**
113			* Removes multiple items from the pool.
114			*
115			* @param string[] $keys
116			* An array of keys that should be removed from the pool.
117			* @throws InvalidArgumentException
118			* If any of the keys in $keys are not a legal value a \Psr\Cache\InvalidArgumentException
119			* MUST be thrown.
120			*
121			* @return bool
122			* True if the items were successfully removed. False if there was an error.
123			*/
124			public function deleteItems(array $keys): bool
125			{
126			return true;
127			}
128
129			/**
130			* Persists a cache item immediately.
131			*
132			* @param CacheItemInterface $item
133			* The cache item to save.
134			*
135			* @return bool
136			* True if the item was successfully persisted. False if there was an error.
137			*/
138			public function save(CacheItemInterface $item): bool
139			{
140			return true;
141			}
142
143			/**
144			* Sets a cache item to be persisted later.
145			*
146			* @param CacheItemInterface $item
147			* The cache item to save.
148			*
149			* @return bool
150			* False if the item could not be queued or if a commit was attempted and failed. True otherwise.
151			*/
152			public function saveDeferred(CacheItemInterface $item): bool
153			{
154			return true;
155			}
156
157			/**
158			* Persists any deferred cache items.
159			*
160			* @return bool
161			* True if all not-yet-saved items were successfully saved or there were none. False otherwise.
162			*/
163			public function commit(): bool
164			{
165			return true;
166			}
167
168			/**
169			* Fetches a value from the pool or computes it if not found.
170			*
171			* On cache misses, a callback is called that should return the missing value.
172			* This callback is given a PSR-6 ItemInterface instance corresponding to the
173			* requested key, that could be used e.g. for expiration control. It could also
174			* be an ItemInterface instance when its additional features are needed.
175			*
176			* @param string $key The key of the item to retrieve from the cache
177			* @param callable\|CallbackInterface $callback Should return the computed value for the given key/item
178			* @param float\|null $beta A float that, as it grows, controls the likeliness of triggering
179			* early expiration. 0 disables it, INF forces immediate expiration.
180			* The default (or providing null) is implementation dependent but should
181			* typically be 1.0, which should provide optimal stampede protection.
182			* See https://en.wikipedia.org/wiki/Cache_stampede#Probabilistic_early_expiration
183			* @param array &$metadata The metadata of the cached item {@see ItemInterface::getMetadata()}
184			*
185			* @return mixed The value corresponding to the provided key
186			*
187			* @throws InvalidArgumentException When $key is not valid or when $beta is negative
188			*/
189			public function get(string $key, callable $callback, float $beta = null, array &$metadata = null)
190			{
191			return null;
192			}
193
194			/**
195			* Removes an item from the pool.
196			*
197			* @param string $key The key to delete
198			*
199			* @throws InvalidArgumentException When $key is not valid
200			*
201			* @return bool True if the item was successfully removed, false if there was any error
202			*/
203			public function delete(string $key): bool
204			{
205			return true;
206			}
207
208			/**
209			* Invalidates cached items using tags.
210			*
211			* @param string[] $tags An array of tags to invalidate
212			*
213			* @return bool True on success
214			*/
215			public function invalidateTags(array $tags): bool
216			{
217			return true;
218			}
219			}
220

Sf4 / Api

Push — master ( ae14df...9d195a )

NoCacheAdapter::commit() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like