masterzydra/magento2-ucache

Module that adds an universal cache to Magento2

1.4.0 2025-04-05 14:22 UTC

Requires

• php: ^8.2
• magento/framework: *

MIT

• David Hein

• cache
• magento
• magento2
• General Cache
• Universal Cache

README

In Magento2 there are a lot of caches built into the system (configuration, layouts, page cache, etc).
But what if you want to cache a string? Which cache can you use? This package could be the answer.

Content

• Usage
• Clean/Flush cache
• Installation
• Updating to latest version

Usage

The values are stored in a table in the database. The getter and setter will serialize/deserialize the given value.

class Demo {
    public function __construct(
        private \MasterZydra\UCache\Helper\UCache $ucache,
    ) { }

    public function doWork()
    {
        // Add a value to the cache
        $this->ucache->save('myModule_cacheKey', ['some' => 'array']);
        // Load a cache key
        $value = $this->ucache->load('myModule_cacheKey');
        // Remove a single cache entry
        $this->ucache->remove('myModule_cacheKey');
        // Flush the entire UCache
        $this->ucache->clean();

        // Cache value for 30 seconds
        $this->ucache->remember('myModule_cacheKey', 30, function () { return 42; });
        // Cache value forever
        $this->ucache->rememberForever('myModule_cacheKey', function () { return 42; });

        // "remember" and "rememberForever" can also be used with functions with arguments
        // The values to pass when the function is called are passed as an array.
        $value = $this->ucache->remember(
            'customerGroupColl',
            10,
            function (CollectionFactory $collFactory, LoggerInterface $logger) {
                $logger->error('remember customer groups');
                return $collFactory->create();
            },
            [$this->collFactory, $this->logger]
        );
    }
}

Clean/Flush cache

Module specific CLI commands

You can use the flush command provided by this package to flush the cache.

# Flush cache
$ php bin/magento ucache:flush

# Remove a specific cache key 
$ php bin/magento ucache:flush myCacheKey

# Remove all cache keys matching a given regex
$ php bin/magento ucache:flush -r ^myPrefix

Magento default CLI commands

You can use the default Magento CLI commands to clean or flush the cache.

Note: The UCache must be enabled in order for the CLI commands to work properly.

Using the cache in your project will always work, even if it is marked as disabled.

# Clean cache
$ php bin/magento cache:clean
$ php bin/magento cache:clean ucache

# Flush cache
$ php bin/magento cache:flush
$ php bin/magento cache:flush ucache

# Enable cache
$ php bin/magento cache:enable ucache

Installation

This Magento2 module can be installed using composer:
> composer require masterzydra/magento2-ucache

To remove it from the list of required packages use the following command:
> composer remove masterzydra/magento2-ucache

Updating to latest version

With the following command composer checks all packages in the composer.json for the latest version:
> composer update

If you only want to check this package for newer versions, you can use
> composer update masterzydra/magento2-ucache