Yii RBAC Database

The package provides Yii Database storage for Yii RBAC.

Detailed build statuses:

RDBMS	Status
SQLite
MySQL
PostgreSQL
Microsoft SQL Server
Oracle

Requirements

• PHP 8.1 or higher.
• PDO PHP extension.
• One of the following drivers:
  • SQLite (minimal required version is 3.8.3)
  • MySQL
  • PostgreSQL
  • Microsoft SQL Server
  • Oracle
• PDO PHP extension for the selected driver.
• In the case of using with SQL Server, a minimal required version of PDO is 5.11.1.

Installation

The package could be installed with composer:

General usage

Configuring database connection

Configuration depends on a selected driver. Here is an example for PostgreSQL:

More comprehensive examples can be found at Yii Database docs.

Working with migrations

This package uses Yii DB Migration for managing database tables required for storages. There are three tables in total (yii_rbac_ prefix is used).

Items storage:

• yii_rbac_item.
• yii_rbac_item_child.

Assignments storage:

• yii_rbac_assignment.

Configuring migrations

Make sure to include these directories as source paths:

• migrations/items;
• migrations/assignments.

When using Yii Console, add this to config/params.php:

and database connection configuration from previous section to DI container (config/common/db.php):

Because item and assignment storages are completely independent, migrations are separated as well to prevent the creation of unused tables. So, for example, if you only want to use assignment storage, add only migrations/assignments to source paths.

Other ways of using migrations are covered here.

Applying migrations

Using with Yii Console:

Other ways of using migrations are covered here.

Reverting migrations

Using with Yii Console:

Other ways of using migrations are covered here.

Using storages

The storages are not intended to be used directly. Instead, use them with Manager from Yii RBAC package:

Note wrapping manager with decorator—it additionally provides database transactions to guarantee data integrity.

Note that it's not necessary to use both DB storages. Combining different implementations is possible. A quite popular case is to manage items via PHP files while storing assignments in a database.

More examples can be found in Yii RBAC documentation.

Syncing storages manually

The storages stay synced thanks to manager, but there can be situations where you need to sync them manually. One of them is using combination with PHP file based storage and editing it manually.

Let's say PHP file is used for items, while database - for assignments, and some items were deleted:

Then related entries in other storage needs to be deleted as well. This can be done within a migration:

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

Mutation testing

The package tests are checked with Infection mutation framework. To run it:

Static analysis

The code is statically analyzed with Psalm. To run static analysis: