README

Database tenant storage for rasuvaeff/yii3-tenancy: TenantProvider backed by a tenants table via yiisoft/db, an optional PSR-16 read-through cache, and a ready-made migration.

Using an AI coding assistant? llms.txt contains a compact API reference you can share with the model. Contributors: see AGENTS.md.

Requirements

Installation

composer require rasuvaeff/yii3-tenancy-db

Register the migrations path and run the migration:

// config/params.php
'yiisoft/db-migration' => [
    'sourcePaths' => [dirname(__DIR__) . '/vendor/rasuvaeff/yii3-tenancy-db/migrations'],
],

./yii migrate:up

Usage

With yiisoft/config no wiring is needed — this package binds TenantProvider to DbTenantProvider (the core deliberately leaves that interface unbound; installing core + this backend just works):

use Rasuvaeff\Yii3Tenancy\CurrentTenant;

final readonly class InvoiceService
{
    public function __construct(private CurrentTenant $currentTenant) {}
    // TenantResolutionMiddleware looks tenants up through DbTenantProvider
}

Manual construction:

use Rasuvaeff\Yii3TenancyDb\CachedTenantProvider;
use Rasuvaeff\Yii3TenancyDb\DbTenantProvider;

$provider = new DbTenantProvider(db: $connection, table: 'tenants');

// optional PSR-16 read-through cache
$cached = new CachedTenantProvider(inner: $provider, cache: $psr16, ttl: 60);
$cached->forget('acme');   // drop the entry after updating/suspending a tenant

Caching semantics: only found tenants are cached (a newly created tenant appears immediately); cache read/write failures are non-fatal; entries expire by TTL or explicit forget().

Enable the cache through params:

// config/params.php
return [
    'rasuvaeff/yii3-tenancy-db' => [
        'table' => 'tenants',
        'cache' => ['enabled' => true, 'ttl' => 60],
    ],
];

Table schema

Invalid rows (unknown status, malformed JSON, invalid id) throw InvalidTenantRowException — never silently skipped or defaulted.

Components

Security

• Lookups use bound parameters via the yiisoft/db query builder — no SQL string interpolation.
• The table name is configuration (developer-controlled), not user input.
• Rows are strictly validated on read; a corrupted row fails loudly instead of producing a half-valid tenant.

Examples

See examples/ for a runnable script.

Development

No PHP/Composer on the host — run in Docker via the composer:2 image:

docker run --rm -v "$PWD":/app -w /app composer:2 composer build

Or with Make: make build, make cs-fix, make psalm, make test.

License

BSD-3-Clause. See LICENSE.md.