se7enxweb/sevenx_valkey_cache

Redis/Valkey backed cache handler for Exponential / eZ Publish Legacy. Replaces disk file storage for template blocks and content view caches.

Maintainers

Package info

github.com/se7enxweb/sevenx_valkey_cache

Homepage

Type:ezpublish-legacy-extension

pkg:composer/se7enxweb/sevenx_valkey_cache

Transparency log

Statistics

Installs: 1

Dependents: 0

Suggesters: 2

Stars: 1

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

v1.0.2.0 2026-07-20 13:25 UTC

Requires

Suggests

  • ext-igbinary: igbinary provides faster and more compact serialization than the default PHP serializer
  • ext-redis: The PHP Redis extension is used to connect to Redis/Valkey servers

GPL-2.0-or-later 815d37baef06d8ecbf207803fb63107905224990

  • 7x <info.woop@se7enx.com>

redisperformancecacheclusterez publishexponentialeZ Publish Legacyvalkey

Published on Packagist.org on 2026-07-20 20:54 UTC

This package is auto-updated.

Last update: 2026-07-20 20:54:50 UTC

README

A Redis/Valkey backed cache handler for Exponential 6.0.15 or later.

It replaces disk file storage for:

  • {valkey-block ...} template blocks
  • content content/view full view cache
  • compiled eZINI cache files

Cache entries are stored in Redis/Valkey with TTL based expiry, generation locks and reverse node / subtree indexes so that publishing content selectively purges the affected cache entries.

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

See the LICENSE file or http://www.gnu.org/licenses/ for the full license text.

Author

Developed and maintained by 7x — https://se7enx.com

Requirements

  • Exponential 6.0.15 or later
  • PHP redis or igbinary extension (php-redis is recommended)
  • A running Redis or Valkey server reachable from the web server

Kernel integration

Exponential 6.0.15 is expected to ship the kernel hooks this extension needs:

  • kernel/content/view.php calls sevenxValkeyCacheBlock for the content view cache.
  • lib/ezutils/classes/ezini.php calls sevenxValkeyINICache from loadCache(), saveCache() and resetCache() for compiled INI arrays.

If the kernel does not yet contain these calls, the same hooks can be applied as a manual patch. The current rollout (which kernels are already patched) is tracked in /root/bin/doc/SEVENX_VALKEY_CACHE_ROLLOUT.md.

Installation

Manual install

  1. Copy or checkout the extension into extension/sevenx_valkey_cache.

  2. Make the extension active in settings/override/site.ini.append.php:

[ExtensionSettings]
ActiveExtensions[]=sevenx_valkey_cache
  1. Regenerate autoloads:
php bin/php/ezpgenerateautoloads.php
  1. (Optional) Clear caches:
php bin/php/ezcache.php --clear-all --allow-root-user

Composer install

composer require se7enxweb/sevenx_valkey_cache

Then activate the extension and regenerate autoloads as described above.

Configuration

Configure the Redis/Valkey connection in settings/override/valkeycache.ini.append.php:

[ValkeyCacheSettings]
Host=127.0.0.1
Port=6379
Database=0
KeyPrefix=sevenx_valkey_cache:

# Unique identifier for this installation. Set to "auto" to derive a hash from
# the database name and site name, or use a fixed string when sharing a cache
# between servers.
InstallationHash=auto

DefaultTTL=3600
LockTTL=30

# Persistent connections may reduce connect time but should be used with care
# when several databases share a php-fpm pool.
Persistent=disabled

# Request-scoped in-memory cache. Keeps a per-request copy of retrieved entries
# to avoid repeated Redis round-trips for the same key on the same page.
LocalCache=enabled

# Cache compiled eZINI arrays in Redis/Valkey instead of local PHP files.
# Requires Exponential 6.0.15 or later.
IniCache=enabled

Content view cache

In Exponential 6.0.15 kernel/content/view.php uses sevenxValkeyCacheBlock for the content view cache backend. This stores full view results in Redis/Valkey instead of disk and dramatically reduces render time for cached nodes.

Compiled INI cache

Exponential 6.0.15 adds eZINI hooks that let the extension store compiled INI arrays in Redis/Valkey through sevenxValkeyINICache. This removes the per-request var/cache/ini/*.php disk touches and makes INI caches cluster-safe.

To enable it, set IniCache=enabled in valkeycache.ini (shown in the configuration example above). The extension also preloads all INI arrays used by the current request with a single MGET.

Usage

{valkey-block} template function

Use {valkey-block} anywhere you would use the built-in {cache-block} but want the rendered output stored in Redis/Valkey.

{valkey-block expiry=3600 subtree_expiry=$node.node_id keys=array( 'my-block', $node.node_id )}
    ... expensive template logic ...
{/valkey-block}

Parameters:

  • expiry — TTL in seconds (default 7200).
  • subtree_expiry — Node id to use as a subtree dependency. When any node under this subtree changes, the block is purged.
  • node_expiry — Node id to use as a node dependency. When the node changes, the block is purged.
  • keys — Additional cache key components (array or scalar).
  • lock — Use generation locks to avoid cache stampedes (default true).
  • ignore_content_expiry — If true, ignore the global template-block-cache and global-template-block-cache expiry timestamps.

Manual cache management

The sevenxValkeyCacheBlock singleton can be used directly in custom code:

$cache = sevenxValkeyCacheBlock::instance();
$cache->put( 'my-key', $content, 3600 );
$content = $cache->get( 'my-key' );
$cache->purge( 'my-key' );
$cache->flush();

Static cache handler

sevenxValkeyCacheHandler is registered as ContentSettings.StaticCacheHandler. It is invoked when content changes and purges the Redis/Valkey view cache and block cache entries that are indexed by the affected node ids and their ancestors.

Implementation notes

The extension deliberately follows the architecture of the mugo_memcache proof-of-concept: a lightweight cache block class, a static cache handler for selective purging, a template function for block caching, a kernel/content/view.php content view cache integration, and a sevenxValkeyINICache backend for compiled INI caches. The storage backend has been changed from Memcache to Redis/Valkey, with added support for TTL based expiry, atomic generation locks, and node/subtree reverse indexes without requiring a relational database.

Current rollout

As of 2026-07-20, sevenx_valkey_cache is installed and active on the following Exponential/eZ Publish docroots:

  • alpha.se7enx.com — /var/www/vhosts/alpha.se7enx.com/doc/alpha.se7enx.com
  • edit.alpha.se7enx.com — /var/www/vhosts/alpha.se7enx.com/doc/edit.alpha.se7enx.com

All other *.se7enx.com, *.ezpublish.se7enx.com, *.exponential.earth and related eZ installations do not yet have the extension or the required kernel hooks. The full rollout status (including kernel patch state per docroot) is tracked in /root/bin/doc/SEVENX_VALKEY_CACHE_ROLLOUT.md.