rasuvaeff/yii3-tenancy-db

Database tenant storage for rasuvaeff/yii3-tenancy

v1.0.0 2026-07-04 08:18 UTC

Requires

• php: 8.3 - 8.5
• psr/simple-cache: ^3.0
• rasuvaeff/yii3-tenancy: ^1.0
• yiisoft/db: ^2.0
• yiisoft/db-migration: ^2.0

Requires (Dev)

• ergebnis/composer-normalize: ^2.51
• friendsofphp/php-cs-fixer: ^3.95
• infection/infection: ^0.33
• maglnet/composer-require-checker: ^4.17
• rasuvaeff/property-testing: ^2.0
• rector/rector: ^2.4
• roave/backward-compatibility-check: ^8.0
• testo/bridge-infection: ^0.1.6
• testo/testo: ^0.10.25
• vimeo/psalm: ^6.16
• yiisoft/cache: ^3.2
• yiisoft/db-sqlite: ^2.0
• yiisoft/test-support: ^3.0

BSD-3-Clause

• Victor Razuvaev

• database
• tenant
• tenancy
• multi-tenancy
• yii3
• yiisoft-db

Published on Packagist.org on 2026-07-04 08:21 UTC

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

Requirement	Version
PHP	8.3 – 8.5
rasuvaeff/yii3-tenancy	^1.0
yiisoft/db	^2.0
yiisoft/db-migration	^2.0 (for the bundled migration)

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

Column	Type	Notes
id	string(64) PK	must satisfy core Tenant::isValidId()
name	string(190)	default ''
status	string(20)	active (default) / suspended
attributes	text	JSON object, default '{}'

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

Components

Class	Role
DbTenantProvider	TenantProvider over yiisoft/db: single-row find() by primary key
CachedTenantProvider	PSR-16 read-through decorator (yii3-tenancy-db.tenant.{key}), forget() invalidation
Exception\InvalidTenantRowException	thrown by the internal row mapper on invalid rows

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.

Script	Shows	Needs server?
db-provider.php	Migration + lookup + cached lookup on in-memory SQLite	no

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.