ArrayCacheStore::isExpired() - Code Metrics - Inspection of "Merge pull request #40 from silviooosilva/CacheerP..." - silviooosilva/CacheerPHP - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( a8c6a0...1905a9 )

by Sílvio

created 2025-07-16 10:20 UTC

ArrayCacheStore::isExpired() A

↳ Parent: ArrayCacheStore

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Silviooosilva\CacheerPhp\CacheStore;

use Silviooosilva\CacheerPhp\Utils\CacheLogger;
use Silviooosilva\CacheerPhp\Interface\CacheerInterface;

/**
 * Class ArrayCacheStore
 * @author Sílvio Silva <https://github.com/silviooosilva>
 * @package Silviooosilva\CacheerPhp
 */
class ArrayCacheStore implements CacheerInterface
{

  /**
  * @param array $arrayStore
  */
  private array $arrayStore = [];

  /**
   * @param boolean
   */
  private bool $success = false;

  /**
   * @param string
   */
  private string $message = '';

  /**
   * @var CacheLogger
   */
  private $logger = null;

  /**
   * ArrayCacheStore constructor.
   * 
   * @param string $logPath
   */
  public function __construct(string $logPath)
  {
    $this->logger = new CacheLogger($logPath);
  }

  /**
   * Appends data to an existing cache item.
   * 
   * @param string $cacheKey
   * @param mixed  $cacheData
   * @param string $namespace
   * @return bool
   */
  public function appendCache(string $cacheKey, mixed $cacheData, string $namespace = '')
  {
      $arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);

      if (!$this->has($cacheKey, $namespace)) {
          $this->setMessage("cacheData can't be appended, because doesn't exist or expired", false);
          $this->logger->debug("{$this->getMessage()} from array driver.");
          return false;
      }

      $this->arrayStore[$arrayStoreKey]['cacheData'] = serialize($cacheData);
      $this->setMessage("Cache appended successfully", true);
      return true;
  }

  /**
   * Builds a unique key for the array store.
   * 
   * @param string $cacheKey
   * @param string $namespace
   * @return string
   */
  private function buildArrayKey(string $cacheKey, string $namespace = '')
  {
    return !empty($namespace) ? ($namespace . ':' . $cacheKey) : $cacheKey;
  }

  /**
   * Clears a specific cache item.
   * 
   * @param string $cacheKey
   * @param string $namespace
   * @return void
   */
  public function clearCache(string $cacheKey, string $namespace = '')
  {
    $arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);
    unset($this->arrayStore[$arrayStoreKey]);
    $this->setMessage("Cache cleared successfully", true);
    $this->logger->debug("{$this->getMessage()} from array driver.");
  }

  /**
   * Decrements a cache item by a specified amount.
   * 
   * @param string $cacheKey
   * @param int $amount
   * @param string $namespace
   * @return bool
   */
  public function decrement(string $cacheKey, int $amount = 1, string $namespace = '')
  {
    return $this->increment($cacheKey, ($amount * -1), $namespace);
  }

  /**
   * Flushes all cache items.
   * 
   * @return void
   */
  public function flushCache()
  {
    unset($this->arrayStore);
    $this->arrayStore = [];
    $this->setMessage("Cache flushed successfully", true);
    $this->logger->debug("{$this->getMessage()} from array driver.");
  }

  /**
   * Stores a cache item permanently.
   * 
   * @param string $cacheKey
   * @param mixed $cacheData
   * @param string $namespace
   * @param int|string $ttl
   * @return void
   */
  public function forever(string $cacheKey, mixed $cacheData)
  {
    $this->putCache($cacheKey, $cacheData, ttl: 31536000 * 1000);
    $this->setMessage($this->getMessage(), $this->isSuccess());
  }

  /**
   * Retrieves a single cache item.
   * 
   * @param string $cacheKey
   * @param string $namespace
   * @param int|string $ttl
   * @return mixed
   */
  public function getCache(string $cacheKey, string $namespace = '', string|int $ttl = 3600)
  {
    $arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);

    if (!$this->has($cacheKey, $namespace)) {
      $this->handleCacheNotFound();
      return false;
    }

    $cacheData = $this->arrayStore[$arrayStoreKey];
    if ($this->isExpired($cacheData)) {
      $this->handleCacheExpired($arrayStoreKey);
      return false;
    }

    $this->setMessage("Cache retrieved successfully", true);
    $this->logger->debug("{$this->getMessage()} from array driver.");
    return $this->serialize($cacheData['cacheData'], false);
  }

  /**
   * Verify if the cache is expired.
   * 
   * @param array $cacheData
   * @return bool
   */
  private function isExpired(array $cacheData): bool
  {
    $expirationTime = $cacheData['expirationTime'] ?? 0;
    $now = time();
    return $expirationTime !== 0 && $now >= $expirationTime;
  }

  /**
   * Handles the case when cache data is not found.
   * 
   * @return void
   */
  private function handleCacheNotFound()
  {
    $this->setMessage("cacheData not found, does not exists or expired", false);
    $this->logger->debug("{$this->getMessage()} from array driver.");
  }

  /**
   * Handles the case when cache data has expired.
   * 
   * @param string $arrayStoreKey
   * @return void
   */
  private function handleCacheExpired(string $arrayStoreKey)
  {
    $parts = explode(':', $arrayStoreKey, 2);
    if (count($parts) === 2) {
      list($np, $key) = $parts;
    } else {
      $np = '';
      $key = $arrayStoreKey;
    }
    $this->clearCache($key, $np);
    $this->setMessage("cacheKey: {$key} has expired.", false);
    $this->logger->debug("{$this->getMessage()} from array driver.");
  }

  /**
   * Gets all items in a specific namespace.
   * 
   * @param string $namespace
   * @return array
   */
  public function getAll(string $namespace = '')
  {
    $results = [];
    foreach ($this->arrayStore as $key => $data) {
      if (strpos($key, $namespace . ':') === 0 || empty($namespace)) {
        $results[$key] = $this->serialize($data['cacheData'], false);
      }
    }
    return $results;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
  }

  /**
   * Retrieves multiple cache items by their keys.
   * 
   * @param array $cacheKeys
   * @param string $namespace
   * @param string|int $ttl
   * @return array
   */
  public function getMany(array $cacheKeys, string $namespace = '', string|int $ttl = 3600)
  {
    $results = [];
    foreach ($cacheKeys as $cacheKey) {
      $results[$cacheKey] = $this->getCache($cacheKey, $namespace, $ttl);
    }
    return $results;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
  }

  /**
   * Checks if a cache item exists.
   * 
   * @param string $cacheKey
   * @param string $namespace
   * @return bool
   */
  public function has(string $cacheKey, string $namespace = '')
  {
    $arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);
    return isset($this->arrayStore[$arrayStoreKey]) && time() < $this->arrayStore[$arrayStoreKey]['expirationTime'];
  }

  /**
   * Increments a cache item by a specified amount.
   * 
   * @param string $cacheKey
   * @param int $amount
   * @param string $namespace
   * @return bool
   */
  public function increment(string $cacheKey, int $amount = 1, string $namespace = '')
  {
    $cacheData = $this->getCache($cacheKey, $namespace);

    if(!empty($cacheData) && is_numeric($cacheData)) {
      $this->putCache($cacheKey, (int)($cacheData + $amount), $namespace);
      $this->setMessage($this->getMessage(), $this->isSuccess());
      return true;
    }

    return false;
  }

  /**
   * Checks if the operation was successful.
   * 
   * @return boolean
   */
  public function isSuccess()
  {
    return $this->success;
  }

  /**
   * Gets the last message.
   * 
   * @return string
   */
  public function getMessage()
  {
    return $this->message;
  }

  /**
   * Stores an item in the cache with a specific TTL.
   * 
   * @param string $cacheKey
   * @param mixed $cacheData
   * @param string $namespace
   * @param int|string $ttl
   * @return bool
   */
  public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', int|string $ttl = 3600)
  {
    $arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);

    $this->arrayStore[$arrayStoreKey] = [
      'cacheData' => serialize($cacheData),
      'expirationTime' => time() + $ttl
    ];

    $this->setMessage("Cache stored successfully", true);
    $this->logger->debug("{$this->getMessage()} from Array driver.");
    return true;
  }

  /**
   * Stores multiple items in the cache in batches.
   * 
   * @param array $items
   * @param string $namespace
   * @param int $batchSize
   * @return void
   */
  public function putMany(array $items, string $namespace = '', int $batchSize = 100)
  {
    $chunks = array_chunk($items, $batchSize, true);

    foreach ($chunks as $chunk) {
      foreach ($chunk as $key => $data) {
          $this->putCache($data['cacheKey'], $data['cacheData'], $namespace);
        }
      }
    $this->setMessage("{$this->getMessage()}", $this->isSuccess());
    $this->logger->debug("{$this->getMessage()} from Array driver.");
  }

  /**
   * Renews the expiration time of a cache item.
   * 
   * @param string $cacheKey
   * @param string|int $ttl
   * @param string $namespace
   * @return void
   */
  public function renewCache(string $cacheKey, int|string $ttl = 3600, string $namespace = '')
  {
    $arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);

    if (isset($this->arrayStore[$arrayStoreKey])) {
        $ttlSeconds = is_numeric($ttl) ? (int) $ttl : strtotime($ttl) - time();
        $this->arrayStore[$arrayStoreKey]['expirationTime'] = time() + $ttlSeconds;
        $this->setMessage("cacheKey: {$cacheKey} renewed successfully", true);
        $this->logger->debug("{$this->getMessage()} from array driver.");
      }
  }

  /**
   * Sets a message and its success status.
   * 
   * @param string  $message
   * @param boolean $success
   * @return void
   */
  private function setMessage(string $message, bool $success)
  {
    $this->message = $message;
    $this->success = $success;
  }

  /**
   * Serializes or unserializes data based on the flag.
   * 
   * @param mixed $data
   * @param bool $serialize
   * @return mixed
   */
  private function serialize(mixed $data, bool $serialize = true)
  {
    return $serialize ? serialize($data) : unserialize($data);
  }
}


1			<?php
2
3			namespace Silviooosilva\CacheerPhp\CacheStore;
4
5			use Silviooosilva\CacheerPhp\Utils\CacheLogger;
6			use Silviooosilva\CacheerPhp\Interface\CacheerInterface;
7
8			/**
9			* Class ArrayCacheStore
10			* @author Sílvio Silva <https://github.com/silviooosilva>
11			* @package Silviooosilva\CacheerPhp
12			*/
13			class ArrayCacheStore implements CacheerInterface
14			{
15
16			/**
17			* @param array $arrayStore
18			*/
19			private array $arrayStore = [];
20
21			/**
22			* @param boolean
23			*/
24			private bool $success = false;
25
26			/**
27			* @param string
28			*/
29			private string $message = '';
30
31			/**
32			* @var CacheLogger
33			*/
34			private $logger = null;
35
36			/**
37			* ArrayCacheStore constructor.
38			*
39			* @param string $logPath
40			*/
41			public function __construct(string $logPath)
42			{
43			$this->logger = new CacheLogger($logPath);
44			}
45
46			/**
47			* Appends data to an existing cache item.
48			*
49			* @param string $cacheKey
50			* @param mixed $cacheData
51			* @param string $namespace
52			* @return bool
53			*/
54			public function appendCache(string $cacheKey, mixed $cacheData, string $namespace = '')
55			{
56			$arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);
57
58			if (!$this->has($cacheKey, $namespace)) {
59			$this->setMessage("cacheData can't be appended, because doesn't exist or expired", false);
60			$this->logger->debug("{$this->getMessage()} from array driver.");
61			return false;
62			}
63
64			$this->arrayStore[$arrayStoreKey]['cacheData'] = serialize($cacheData);
65			$this->setMessage("Cache appended successfully", true);
66			return true;
67			}
68
69			/**
70			* Builds a unique key for the array store.
71			*
72			* @param string $cacheKey
73			* @param string $namespace
74			* @return string
75			*/
76			private function buildArrayKey(string $cacheKey, string $namespace = '')
77			{
78			return !empty($namespace) ? ($namespace . ':' . $cacheKey) : $cacheKey;
79			}
80
81			/**
82			* Clears a specific cache item.
83			*
84			* @param string $cacheKey
85			* @param string $namespace
86			* @return void
87			*/
88			public function clearCache(string $cacheKey, string $namespace = '')
89			{
90			$arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);
91			unset($this->arrayStore[$arrayStoreKey]);
92			$this->setMessage("Cache cleared successfully", true);
93			$this->logger->debug("{$this->getMessage()} from array driver.");
94			}
95
96			/**
97			* Decrements a cache item by a specified amount.
98			*
99			* @param string $cacheKey
100			* @param int $amount
101			* @param string $namespace
102			* @return bool
103			*/
104			public function decrement(string $cacheKey, int $amount = 1, string $namespace = '')
105			{
106			return $this->increment($cacheKey, ($amount * -1), $namespace);
107			}
108
109			/**
110			* Flushes all cache items.
111			*
112			* @return void
113			*/
114			public function flushCache()
115			{
116			unset($this->arrayStore);
117			$this->arrayStore = [];
118			$this->setMessage("Cache flushed successfully", true);
119			$this->logger->debug("{$this->getMessage()} from array driver.");
120			}
121
122			/**
123			* Stores a cache item permanently.
124			*
125			* @param string $cacheKey
126			* @param mixed $cacheData
127			* @param string $namespace
128			* @param int\|string $ttl
129			* @return void
130			*/
131			public function forever(string $cacheKey, mixed $cacheData)
132			{
133			$this->putCache($cacheKey, $cacheData, ttl: 31536000 * 1000);
134			$this->setMessage($this->getMessage(), $this->isSuccess());
135			}
136
137			/**
138			* Retrieves a single cache item.
139			*
140			* @param string $cacheKey
141			* @param string $namespace
142			* @param int\|string $ttl
143			* @return mixed
144			*/
145			public function getCache(string $cacheKey, string $namespace = '', string\|int $ttl = 3600)
146			{
147			$arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);
148
149			if (!$this->has($cacheKey, $namespace)) {
150			$this->handleCacheNotFound();
151			return false;
152			}
153
154			$cacheData = $this->arrayStore[$arrayStoreKey];
155			if ($this->isExpired($cacheData)) {
156			$this->handleCacheExpired($arrayStoreKey);
157			return false;
158			}
159
160			$this->setMessage("Cache retrieved successfully", true);
161			$this->logger->debug("{$this->getMessage()} from array driver.");
162			return $this->serialize($cacheData['cacheData'], false);
163			}
164
165			/**
166			* Verify if the cache is expired.
167			*
168			* @param array $cacheData
169			* @return bool
170			*/
171			private function isExpired(array $cacheData): bool
172			{
173			$expirationTime = $cacheData['expirationTime'] ?? 0;
174			$now = time();
175			return $expirationTime !== 0 && $now >= $expirationTime;
176			}
177
178			/**
179			* Handles the case when cache data is not found.
180			*
181			* @return void
182			*/
183			private function handleCacheNotFound()
184			{
185			$this->setMessage("cacheData not found, does not exists or expired", false);
186			$this->logger->debug("{$this->getMessage()} from array driver.");
187			}
188
189			/**
190			* Handles the case when cache data has expired.
191			*
192			* @param string $arrayStoreKey
193			* @return void
194			*/
195			private function handleCacheExpired(string $arrayStoreKey)
196			{
197			$parts = explode(':', $arrayStoreKey, 2);
198			if (count($parts) === 2) {
199			list($np, $key) = $parts;
200			} else {
201			$np = '';
202			$key = $arrayStoreKey;
203			}
204			$this->clearCache($key, $np);
205			$this->setMessage("cacheKey: {$key} has expired.", false);
206			$this->logger->debug("{$this->getMessage()} from array driver.");
207			}
208
209			/**
210			* Gets all items in a specific namespace.
211			*
212			* @param string $namespace
213			* @return array
214			*/
215			public function getAll(string $namespace = '')
216			{
217			$results = [];
218			foreach ($this->arrayStore as $key => $data) {
219			if (strpos($key, $namespace . ':') === 0 \|\| empty($namespace)) {
220			$results[$key] = $this->serialize($data['cacheData'], false);
221			}
222			}
223			return $results;
			0 ignored issues – show Bug Best Practice introduced 2025-07-16 01:10 UTC by Report Bug Copy Issue Report The expression `return $results` returns the type `array` which is incompatible with the return type mandated by `Silviooosilva\CacheerPhp...heerInterface::getAll()` of `Silviooosilva\CacheerPhp...face\CacheDataFormatter`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
224			}
225
226			/**
227			* Retrieves multiple cache items by their keys.
228			*
229			* @param array $cacheKeys
230			* @param string $namespace
231			* @param string\|int $ttl
232			* @return array
233			*/
234			public function getMany(array $cacheKeys, string $namespace = '', string\|int $ttl = 3600)
235			{
236			$results = [];
237			foreach ($cacheKeys as $cacheKey) {
238			$results[$cacheKey] = $this->getCache($cacheKey, $namespace, $ttl);
239			}
240			return $results;
			0 ignored issues – show Bug Best Practice introduced 2025-07-16 01:10 UTC by Report Bug Copy Issue Report The expression `return $results` returns the type `array` which is incompatible with the return type mandated by `Silviooosilva\CacheerPhp...eerInterface::getMany()` of `Silviooosilva\CacheerPhp...face\CacheDataFormatter`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
241			}
242
243			/**
244			* Checks if a cache item exists.
245			*
246			* @param string $cacheKey
247			* @param string $namespace
248			* @return bool
249			*/
250			public function has(string $cacheKey, string $namespace = '')
251			{
252			$arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);
253			return isset($this->arrayStore[$arrayStoreKey]) && time() < $this->arrayStore[$arrayStoreKey]['expirationTime'];
254			}
255
256			/**
257			* Increments a cache item by a specified amount.
258			*
259			* @param string $cacheKey
260			* @param int $amount
261			* @param string $namespace
262			* @return bool
263			*/
264			public function increment(string $cacheKey, int $amount = 1, string $namespace = '')
265			{
266			$cacheData = $this->getCache($cacheKey, $namespace);
267
268			if(!empty($cacheData) && is_numeric($cacheData)) {
269			$this->putCache($cacheKey, (int)($cacheData + $amount), $namespace);
270			$this->setMessage($this->getMessage(), $this->isSuccess());
271			return true;
272			}
273
274			return false;
275			}
276
277			/**
278			* Checks if the operation was successful.
279			*
280			* @return boolean
281			*/
282			public function isSuccess()
283			{
284			return $this->success;
285			}
286
287			/**
288			* Gets the last message.
289			*
290			* @return string
291			*/
292			public function getMessage()
293			{
294			return $this->message;
295			}
296
297			/**
298			* Stores an item in the cache with a specific TTL.
299			*
300			* @param string $cacheKey
301			* @param mixed $cacheData
302			* @param string $namespace
303			* @param int\|string $ttl
304			* @return bool
305			*/
306			public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', int\|string $ttl = 3600)
307			{
308			$arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);
309
310			$this->arrayStore[$arrayStoreKey] = [
311			'cacheData' => serialize($cacheData),
312			'expirationTime' => time() + $ttl
313			];
314
315			$this->setMessage("Cache stored successfully", true);
316			$this->logger->debug("{$this->getMessage()} from Array driver.");
317			return true;
318			}
319
320			/**
321			* Stores multiple items in the cache in batches.
322			*
323			* @param array $items
324			* @param string $namespace
325			* @param int $batchSize
326			* @return void
327			*/
328			public function putMany(array $items, string $namespace = '', int $batchSize = 100)
329			{
330			$chunks = array_chunk($items, $batchSize, true);
331
332			foreach ($chunks as $chunk) {
333			foreach ($chunk as $key => $data) {
334			$this->putCache($data['cacheKey'], $data['cacheData'], $namespace);
335			}
336			}
337			$this->setMessage("{$this->getMessage()}", $this->isSuccess());
338			$this->logger->debug("{$this->getMessage()} from Array driver.");
339			}
340
341			/**
342			* Renews the expiration time of a cache item.
343			*
344			* @param string $cacheKey
345			* @param string\|int $ttl
346			* @param string $namespace
347			* @return void
348			*/
349			public function renewCache(string $cacheKey, int\|string $ttl = 3600, string $namespace = '')
350			{
351			$arrayStoreKey = $this->buildArrayKey($cacheKey, $namespace);
352
353			if (isset($this->arrayStore[$arrayStoreKey])) {
354			$ttlSeconds = is_numeric($ttl) ? (int) $ttl : strtotime($ttl) - time();
355			$this->arrayStore[$arrayStoreKey]['expirationTime'] = time() + $ttlSeconds;
356			$this->setMessage("cacheKey: {$cacheKey} renewed successfully", true);
357			$this->logger->debug("{$this->getMessage()} from array driver.");
358			}
359			}
360
361			/**
362			* Sets a message and its success status.
363			*
364			* @param string $message
365			* @param boolean $success
366			* @return void
367			*/
368			private function setMessage(string $message, bool $success)
369			{
370			$this->message = $message;
371			$this->success = $success;
372			}
373
374			/**
375			* Serializes or unserializes data based on the flag.
376			*
377			* @param mixed $data
378			* @param bool $serialize
379			* @return mixed
380			*/
381			private function serialize(mixed $data, bool $serialize = true)
382			{
383			return $serialize ? serialize($data) : unserialize($data);
384			}
385			}
386

silviooosilva / CacheerPHP

Push — main ( a8c6a0...1905a9 )

ArrayCacheStore::isExpired() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like