1. <?php
  3. /**
  4. * API Caching with Manual Overrides
  5. *
  6. * This function caches the results of an API call. It allows for manual
  7. * overriding of the cache if needed.
  8. *
  9. * @param callable $api_call A callable (function) that makes the API call.
  10. * Should return the API response data.
  11. * @param string $cache_key A unique key for the cache entry.
  12. * @param int $cache_duration Cache duration in seconds. Default: 3600 (1 hour).
  13. * @return mixed The cached result or the result of the API call if not cached.
  14. */
  15. function cache_api_response(callable $api_call, string $cache_key, int $cache_duration = 3600)
  16. {
  17. static $cache = []; // Static array to store cached data.
  19. // Check if the data is already in the cache.
  20. if (isset($cache[$cache_key])) {
  21. $timestamp = time();
  22. if ($timestamp - $cache[$cache_key]['timestamp'] < $cache_duration) {
  23. // Cache hit: return the cached data.
  24. return $cache[$cache_key]['data'];
  25. } else {
  26. // Cache expired: remove the expired entry.
  27. unset($cache[$cache_key]);
  28. }
  29. }
  31. // Cache miss: make the API call.
  32. $data = $api_call();
  34. // Store the data in the cache.
  35. $cache[$cache_key] = [
  36. 'data' => $data,
  37. 'timestamp' => time(),
  38. ];
  40. return $data;
  41. }
  44. /**
  45. * Example Usage:
  46. */
  48. /**
  49. * Simulate an API call. Replace this with your actual API call.
  50. * This example returns some dummy data.
  51. * @return array
  52. */
  53. function get_api_data(): array {
  54. // Simulate an API request
  55. sleep(1); // Simulate network latency
  56. return ['message' => 'API Response Data', 'timestamp' => time()];
  57. }
  60. // Example 1: Using the cache
  61. $cache_key = 'my_api_data';
  62. $data = cache_api_response(function () { return get_api_data(); }, $cache_key);
  63. echo "Data from cache: " . json_encode($data) . "\n";
  65. // Example 2: Manual override
  66. $data = cache_api_response(function () { return get_api_data(); }, $cache_key, 60); //Cache for 60 seconds
  67. echo "Data after 60 seconds from cache: " . json_encode($data) . "\n";
  69. // Example 3: API call without caching (override)
  70. $data = get_api_data(); //This will bypass the cache.
  71. echo "Data from API call (no cache): " . json_encode($data) . "\n";
  74. ?>

Add your comment