README

Redis-backed feature flag provider for Yii3 applications. Implements the FlagProvider interface from rasuvaeff/yii3-feature-flags and reads flag configuration from a Redis HASH via HGETALL.

Using an AI coding assistant? llms.txt contains a compact API reference you can ingest in your prompt context.

Requirements

• PHP 8.3+
• rasuvaeff/yii3-feature-flags ^1.0
• predis/predis ^2.0

Installation

composer require rasuvaeff/yii3-feature-flags-redis

Requires rasuvaeff/yii3-feature-flags ^2.0. With Yii3 config-plugin this package binds FlagProvider automatically — do not also bind FlagProvider in your application or another backend, or yiisoft/config reports a Duplicate key error.

Redis storage format

One Redis HASH per flag set:

• Key: {prefix}:{version}:flags
• Field: flag name
• Value: JSON payload

{
    "enabled": true,
    "salt": "",
    "rollout": 100,
    "killSwitch": false,
    "environments": ["production"]
}

Usage

use Rasuvaeff\Yii3FeatureFlags\FeatureFlags;
use Rasuvaeff\Yii3FeatureFlagsRedis\RedisFlagProvider;

$provider = new RedisFlagProvider(
    client: $predis,             // Predis\ClientInterface
    prefix: 'feature-flags',     // optional, default 'feature-flags'
    version: 'v1',               // optional, default 'v1'
);

$featureFlags = new FeatureFlags(provider: $provider);

if ($featureFlags->isEnabled('new-checkout')) {
    // new checkout flow
}

API reference

Security

• Kill switch, rollout hash logic, and environment targeting remain in the core package — Redis is only a configuration source.
• Invalid JSON, wrong types, out-of-range rollout, or invalid flag names throw InvalidFlagPayloadException instead of silently enabling features. Core validation errors are wrapped, so callers only need to catch InvalidFlagPayloadException.
• Read-only: no write operations are performed.

Examples

See examples/ for runnable scripts.

Development

composer build          # full gate: validate + normalize + cs + psalm + test
composer cs:fix         # auto-fix code style
composer psalm          # static analysis
composer test           # run tests

License

BSD-3-Clause. See LICENSE.md.