PHPackages yiisoft/rbac-db - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. yiisoft/rbac-db ActiveLibrary[Framework](/categories/framework) yiisoft/rbac-db =============== Yii RBAC Database storage 2.1.0(5mo ago)198.1k↓15.8%6[8 issues](https://github.com/yiisoft/rbac-db/issues)[1 PRs](https://github.com/yiisoft/rbac-db/pulls)1BSD-3-ClausePHPPHP 8.1 - 8.5CI passing Since Apr 20Pushed 5mo ago14 watchersCompare [ Source](https://github.com/yiisoft/rbac-db)[ Packagist](https://packagist.org/packages/yiisoft/rbac-db)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-rbac-db/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (3)Dependencies (13)Versions (5)Used By (1) [ ![Yii](https://github.com/yiisoft.png) ](https://github.com/yiisoft) Yii RBAC Database ================= [](#yii-rbac-database) [![Latest Stable Version](https://camo.githubusercontent.com/f30e65e116e9cebd4fb80119b0c7601ccecf271bda2337f8bbc427f281ce21f5/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f726261632d64622f76)](https://packagist.org/packages/yiisoft/rbac-db)[![Total Downloads](https://camo.githubusercontent.com/9bf79677bb1056bc9870ebe6908aa827033b8d5397581875e005e61ef2f4d232/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f726261632d64622f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/rbac-db)[![codecov](https://camo.githubusercontent.com/47408518ab170c165d0740df5f06a9ea4ddfbc60df9386afc04bd05e75a93cc1/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f726261632d64622f67726170682f62616467652e7376673f746f6b656e3d5955384c56424e435138)](https://codecov.io/gh/yiisoft/rbac-db)[![Mutation testing badge](https://camo.githubusercontent.com/22cda41a64eee15455d78ee03d10f42f4e28235af776c6e359744613d164a290/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f6674253246726261632d64622532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/rbac-db/master)[![Static analysis](https://github.com/yiisoft/rbac-db/actions/workflows/static.yml/badge.svg?branch=master)](https://github.com/yiisoft/rbac-db/actions/workflows/static.yml?query=branch%3Amaster)[![type-coverage](https://camo.githubusercontent.com/134fe306dc92e0aebf0b2714176d9f34b8c6d1e96a438727b8f72139a1a46458/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f726261632d64622f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/rbac-db) The package provides [Yii Database](https://github.com/yiisoft/db) storage for [Yii RBAC](https://github.com/yiisoft/rbac). Detailed build statuses: RDBMSStatusSQLite[![SQLite status](https://github.com/yiisoft/rbac-db/actions/workflows/sqlite.yml/badge.svg?branch=master)](https://github.com/yiisoft/rbac-db/actions/workflows/sqlite.yml?query=branch%3Amaster)MySQL[![MYSQL status](https://github.com/yiisoft/rbac-db/actions/workflows/mysql.yml/badge.svg?branch=master)](https://github.com/yiisoft/rbac-db/actions/workflows/mysql.yml?query=branch%3Amaster)PostgreSQL[![PostgreSQL status](https://github.com/yiisoft/rbac-db/actions/workflows/pgsql.yml/badge.svg?branch=master)](https://github.com/yiisoft/rbac-db/actions/workflows/pgsql.yml?query=branch%3Amaster)Microsoft SQL Server[![Microsoft SQL Server status](https://github.com/yiisoft/rbac-db/actions/workflows/mssql.yml/badge.svg?branch=master)](https://github.com/yiisoft/rbac-db/actions/workflows/mssql.yml?query=branch%3Amaster)Oracle[![Oracle status](https://github.com/yiisoft/rbac-db/actions/workflows/oracle.yml/badge.svg?branch=master)](https://github.com/yiisoft/rbac-db/actions/workflows/oracle.yml?query=branch%3Amaster)Requirements ------------ [](#requirements) - PHP 8.1 - 8.5. - `PDO` PHP extension. - One of the following drivers: - [SQLite](https://github.com/yiisoft/db-sqlite) (minimal required version is 3.8.3) - [MySQL](https://github.com/yiisoft/db-mysql) - [PostgreSQL](https://github.com/yiisoft/db-pgsql) - [Microsoft SQL Server](https://github.com/yiisoft/db-mssql) - [Oracle](https://github.com/yiisoft/db-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 ------------ [](#installation) The package could be installed with [Composer](https://getcomposer.org): ``` composer require yiisoft/rbac-db ``` General usage ------------- [](#general-usage) ### Configuring database connection [](#configuring-database-connection) Configuration depends on a selected driver. Here is an example for PostgreSQL: ``` use Yiisoft\Cache\ArrayCache; // Requires https://github.com/yiisoft/cache use Yiisoft\Db\Cache\SchemaCache; use Yiisoft\Db\Pgsql\Connection; use Yiisoft\Db\Pgsql\Driver; $pdoDriver = new Driver('pgsql:host=127.0.0.1;dbname=yiitest;port=5432', 'user', 'password'); $pdoDriver->charset('UTF8'); $connection = Connection( $pdoDriver, new SchemaCache( new ArrayCache(), // Any other PSR-16 compatible cache can be used. ) ); ``` More comprehensive examples can be found at [Yii Database docs](https://github.com/yiisoft/db/blob/master/docs/guide/en/README.md#prerequisites). ### Working with migrations [](#working-with-migrations) This package uses [Yii DB Migration](https://github.com/yiisoft/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 [](#configuring-migrations) Make sure to include these directories as source paths: - [migrations/items](./migrations/items); - [migrations/assignments](./migrations/assignments). When using [Yii Console](https://github.com/yiisoft/yii-console), add this to `config/params.php`: ``` 'yiisoft/db-migration' => [ // ... 'sourcePaths' => [ dirname(__DIR__) . '/vendor/yiisoft/rbac-db/migrations/items', dirname(__DIR__) . '/vendor/yiisoft/rbac-db/migrations/assignments', ], ], ``` and database connection configuration from [previous section](#configuring-database-connection) to DI container `config/common/db.php`: ``` use Yiisoft\Db\Connection\ConnectionInterface; use Yiisoft\Db\Pgsql\Connection as PgsqlConnection; return [ ConnectionInterface::class => [ 'class' => PgsqlConnection::class, '__construct()' => [ // ... ], ] ]; ``` 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](./migrations/assignments) to source paths. Other ways of using migrations are covered [here](https://github.com/yiisoft/db-migration#usage). #### Applying migrations [](#applying-migrations) Using with [Yii Console](https://github.com/yiisoft/yii-console): ``` ./yii migrate:up ``` Other ways of using migrations are covered [here](https://github.com/yiisoft/db-migration#usage). #### Reverting migrations [](#reverting-migrations) Using with [Yii Console](https://github.com/yiisoft/yii-console): ``` ./yii migrate:down --limit=2 ``` Other ways of using migrations are covered [here](https://github.com/yiisoft/db-migration#usage). ### Using storages [](#using-storages) The storages are not intended to be used directly. Instead, use them with `Manager` from [Yii RBAC](https://github.com/yiisoft/rbac) package: ``` use Yiisoft\Db\Connection\ConnectionInterface; use Yiisoft\Rbac\Db\AssignmentsStorage; use Yiisoft\Rbac\Db\ItemsStorage; use Yiisoft\Rbac\Db\TransactionalManagerDecorator; use Yiisoft\Rbac\Manager; use Yiisoft\Rbac\Permission; use Yiisoft\Rbac\RuleFactoryInterface; /** @var ConnectionInterface $database */ $itemsStorage = new ItemsStorage($database); $assignmentsStorage = new AssignmentsStorage($database); /** @var RuleFactoryInterface $rulesContainer */ $manager = new TransactionalManagerDecorator( new Manager( itemsStorage: $itemsStorage, assignmentsStorage: $assignmentsStorage, // Requires https://github.com/yiisoft/rbac-rules-container or another compatible factory. ruleFactory: $rulesContainer, ), ); $manager->addPermission(new Permission('posts.create')); ``` > 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](https://github.com/yiisoft/rbac-php) while storing assignments in a database. More examples can be found in [Yii RBAC](https://github.com/yiisoft/rbac) documentation. ### Syncing storages manually [](#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](https://github.com/yiisoft/rbac-php/?tab=readme-ov-file#file-structure). Let's say PHP file is used for items, while database - for assignments, and some items were deleted: ``` return [ [ 'name' => 'posts.admin', 'type' => 'role', 'created_at' => 1683707079, 'updated_at' => 1683707079, 'children' => [ 'posts.redactor', 'posts.delete', 'posts.update.all', ], ], - [ - 'name' => 'posts.redactor', - 'type' => 'role', - 'created_at' => 1683707079, - 'updated_at' => 1683707079, - 'children' => [ - 'posts.viewer', - 'posts.create', - 'posts.update', - ], - ], [ 'name' => 'posts.viewer', 'type' => 'role', 'created_at' => 1683707079, 'updated_at' => 1683707079, 'children' => [ 'posts.view', ], ], [ 'name' => 'posts.view', 'type' => 'permission', 'created_at' => 1683707079, 'updated_at' => 1683707079, ], [ 'name' => 'posts.create', 'type' => 'permission', 'created_at' => 1683707079, 'updated_at' => 1683707079, ], - [ - 'name' => 'posts.update', - 'rule_name' => 'is_author', - 'type' => 'permission', - 'created_at' => 1683707079, - 'updated_at' => 1683707079, - ], [ 'name' => 'posts.delete', 'type' => 'permission', 'created_at' => 1683707079, 'updated_at' => 1683707079, ], [ 'name' => 'posts.update.all', 'type' => 'permission', 'created_at' => 1683707079, 'updated_at' => 1683707079, ], ]; ``` Then related entries in other storage needs to be deleted as well. This can be done within a migration: ``` use Yiisoft\Db\Migration\MigrationBuilder; use Yiisoft\Db\Migration\RevertibleMigrationInterface; use Yiisoft\Db\Migration\TransactionalMigrationInterface; final class M240229184400DeletePostUpdateItems implements RevertibleMigrationInterface, TransactionalMigrationInterface { private const TABLE_PREFIX = 'yii_rbac_'; private const ASSIGNMENTS_TABLE = self::TABLE_PREFIX . 'assignment'; public function up(MigrationBuilder $b): void { $b ->getDb() ->createCommand() ->delete(self::ASSIGNMENTS_TABLE, ['item_name' => ['posts.redactor', 'posts.update']]) ->execute(); } public function down(MigrationBuilder $b): void; { } } ``` Documentation ------------- [](#documentation) - [Internals](docs/internals.md) If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). License ------- [](#license) The Yii RBAC Database is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information. Maintained by [Yii Software](https://www.yiiframework.com/). Support the project ------------------- [](#support-the-project) [![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft) Follow updates -------------- [](#follow-updates) [![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack) ### Health Score 50 — FairBetter than 96% of packages Maintenance64 Regular maintenance activity Popularity36 Limited adoption so far Community26 Small or concentrated contributor base Maturity65 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~487 days Total 3 Last Release 151d ago Major Versions 1.0.0 → 2.0.02024-03-07 PHP version history (3 changes)1.0.0PHP ^8.0 2.0.0PHP ^8.1 2.1.0PHP 8.1 - 8.5 ### Community Maintainers ![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe) ![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark) ![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire) ![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol) --- Top Contributors [![arogachev](https://avatars.githubusercontent.com/u/8326201?v=4)](https://github.com/arogachev "arogachev (34 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (21 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (13 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (7 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (3 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (2 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (2 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)") --- Tags access-controldbhacktoberfestrbacyii3storagedbrbacyii ### Code Quality TestsPHPUnit Static AnalysisPsalm, Rector Type Coverage Yes ### Embed Badge ![Health badge](/badges/yiisoft-rbac-db/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-rbac-db/health.svg)](https://phpackages.com/packages/yiisoft-rbac-db) ``` ### Alternatives [yiisoft/yii2-queue Yii2 Queue Extension which supports queues based on DB, Redis, RabbitMQ, Beanstalk, SQS, and Gearman 1.1k10.4M155](/packages/yiisoft-yii2-queue)[yiisoft/rbac-cycle-db Yii RBAC Cycle Database storage 1723.1k](/packages/yiisoft-rbac-cycle-db)[yiisoft/rbac-php Yii RBAC PHP File Storage 2472.4k1](/packages/yiisoft-rbac-php)[yiisoft/rbac Yii Role-Based Access Control 76148.4k9](/packages/yiisoft-rbac)[yiisoft/active-record Active record pattern implementation 11883.6k13](/packages/yiisoft-active-record)[yiisoft/access An interface for checking access 31289.6k3](/packages/yiisoft-access) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)