mk4u/cache

A simple cache library.

v0.3.2 2025-03-21 13:49 UTC

Requires

• psr/simple-cache: ^3.0

Requires (Dev)

• symfony/var-dumper: ^7.1

MIT

• alexsandrov16

README

A simple and flexible cache system for PHP.

Features

• Support for multiple cache drivers (APCu and files)
• Implementation of the Psr\SimpleCache\CacheInterface interface.
• Efficient storage and retrieval of data.

Important

The file driver Mk4U\Cache\Drivers\File is suitable for storing small amounts of data in cache. However, as the number of records increases, performance may be affected due to the latency of disk I/O operations.

For applications that require storing large volumes of data or high performance, it is recommended to consider using in-memory cache drivers, such as APCu, which are designed to handle large amounts of data more efficiently.

Requirements

• PHP 8.2 or higher
• APCu extension (optional)

Installation

composer require mk4u/cache

Usage.

Configuration

To use the library, you must first create an instance of the cache driver you want to use. The library includes a Mk4U\Cache\CacheFactory that makes it easy to create instances of the cache drivers.

Tip

If no parameters are passed to the Mk4U\Cache\CacheFactory::create(), an object of type Mk4U\Cache\Drivers\File will be created by default.

Note

By default the Mk4U\Cache\Drivers\File object sets the following configuration parameters:

[
   //extension of cache files
   'ext' =>'cache',
   //directory where the cache will be stored, if it does not exist create it.
   'dir' => '/cache',
   //cache lifetime in seconds (default 5 minutes.)
   'ttl' => 300
]

Example of use with the Mk4U\Cache\Drivers\File driver

require 'vendor/autoload.php';

// Cache driver configuration
$config = [
    'ext' => 'txt', // Extension of cache files.
    'dir' => '/cache', // Directory where the cache will be stored
    'ttl' => 3600 // Cache lifetime in seconds.
];

// Create an instance of the file cache driver.
$cache = Mk4U\Cache\CacheFactory::create('file', $config);

Important

Make sure you set the necessary permissions for the creation of directories and cache files.

Example of use with Mk4U\Cache\Drivers\Apcu driver

require 'vendor/autoload.php';

// Cache driver configuration
$config = [
    'ttl' => 3600 // cache lifetime in seconds (default 5 minutes.)
];

// Create an instance of the APCu cache driver.
$cache = Mk4U\Cache\CacheFactory::create('apcu', $config);

Mk4U\Cache\Drivers\Apcu has only one configurable parameter and it is ttl, by default its value is 300 seconds (5 minutes).

Available methods

The cache class implements the following methods of the CacheInterface interface:

• get(string $key, mixed $default = null): mixed
• set(string $key, mixed $value, null|int|DateInterval $ttl = null): bool
• delete(string $key): bool
• clear(): bool
• getMultiple(iterable $keys, mixed $default = null): iterable
• setMultiple(iterable $values, null|int|DateInterval $ttl = null): bool
• deleteMultiple(iterable $keys): bool
• has(string $key): bool

Example of use of the methods

Storing a value in the cache

// Store the value in the cache
$cache->set('my_key', 'Hello, World!');

Retrieve a value from the cache

// Retrieve cache value
$cachedValue = $cache->get('my_key', 'Default value');

echo $cachedValue; // Print: Hello, World!

Remove a value from the cache

// Delete the value from the cache
$cache->delete('my_key');

Checks if a value exists in the cache by its key

// checks if a value exists
return $cache->has('my_key'); //false

Clear the entire cache

// Clear the entire cache
$cache->clear();

Handling multiple values

You can store, retrieve and delete multiple values from the cache using the setMultiple, getMultiple and deleteMultiple methods.

Storing multiple values

$values = [
    'key1' => 'Value 1',
    'key2' => 'Value 2'
];

$cache->setMultiple($values);

Retrieve multiple values

$keys = ['key1', 'key2'];
$cachedValues = $cache->getMultiple($keys, 'Default value');

print_r($cachedValues); // Print stored values

Delete multiple values

$keysToDelete = ['key1', 'key2'];
$cache->deleteMultiple($keysToDelete);

Exceptions

The library throws the following exceptions:

• Mk4U\Cache\Exceptions\CacheException: for cache related errors.
• Mk4U\Cache\Exceptions\InvalidArgumentException: For invalid arguments.

Contributions

Contributions are welcome. If you wish to contribute, please open an issue or a pull request in the repository.

License

This project is licensed under the MIT License.

Contact

If you have any questions or comments, feel free to contact me at Telegram.