ap-lib/persistent-cache

Caching of an unchanging array is typically prepared on one computer and used on another

dev-main 2025-03-09 23:32 UTC

Requires

• php: ^8.3
• ap-lib/sanitizer: dev-main

Requires (Dev)

• phpunit/phpunit: 10.5.*

MIT

• Anton Panfilov

README

Caching of an unchanging array is typically prepared on one computer and used on another.

Installation

composer require ap-lib/persistent-cache

Features

• Interface for saving and loading arrays
• Implementation for saving and loading arrays to a PHP file

Requirements

• PHP 8.3 or higher

Getting Started

$original_array = [
    "hello" => "world",
    "foo"   => "boo",
];

// Set up the cache object (in this case, it's just a filename)
$cache = new PhpFilePersistentCache("data.php");

// Store the array in the cache
$cache->set($original_array);

// Retrieve the array from the cache
$retrieved_array = $cache->get();

// RESULT: $retrieved_array will equal $original_array

IMPORTANT: The array can only contain primitive data types such as int, float, bool, string, and null:

$original_array = [
    "hello" => "world",
    "foo"   => "boo",
    "object" => new Exception("hello world"),
];

$expected_array = [
    "hello" => "world",
    "foo"   => "boo",
    "object" => null,
];

// Set up the cache object (in this case, it's just a filename)
$cache = new PhpFilePersistentCache("data.php");

// Store the array in the cache
$cache->set($original_array);

// Retrieve the array from the cache
$retrieved_array = $cache->get();

// RESULT: $retrieved_array will equal $expected_array