PHPackages yiisoft/rbac-cycle-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-cycle-db ActiveLibrary[Framework](/categories/framework) yiisoft/rbac-cycle-db ===================== Yii RBAC Cycle Database storage 3.0.0(2y ago)1723.1k—0.9%7[5 issues](https://github.com/yiisoft/rbac-cycle-db/issues)BSD-3-ClausePHPPHP ^8.1CI passing Since Mar 10Pushed 5mo ago13 watchersCompare [ Source](https://github.com/yiisoft/rbac-cycle-db)[ Packagist](https://packagist.org/packages/yiisoft/rbac-cycle-db)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/yiisoft)[ Fund](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-rbac-cycle-db/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (3)Dependencies (11)Versions (5)Used By (0) [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft) Yii RBAC Cycle Database ======================= [](#yii-rbac-cycle-database) [![Latest Stable Version](https://camo.githubusercontent.com/3915281aa036a14b30f12ad4d83cc4c571a62c96c63baf2e7316cf9a3fc3f7d0/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f726261632d6379636c652d64622f76)](https://packagist.org/packages/yiisoft/rbac-cycle-db)[![Total Downloads](https://camo.githubusercontent.com/216cd83236cff724c6b2071bd6861c665124cb3b7efe300480bbe0a05e7e1fe8/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f726261632d6379636c652d64622f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/rbac-cycle-db)[![codecov](https://camo.githubusercontent.com/e4f7868c2de24eb446598a90d76af2b5050b04c346386b3e346e409d8c1b5b2e/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f726261632d6379636c652d64622f67726170682f62616467652e7376673f746f6b656e3d4f414142464343433741)](https://codecov.io/gh/yiisoft/rbac-cycle-db)[![Mutation testing badge](https://camo.githubusercontent.com/56c6895855585cd6a692b1a16b394bf0ced5d38c4d0157ab7f5385d2346ba88f/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f6674253246726261632d6379636c652d64622532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/rbac-cycle-db/master)[![static analysis](https://github.com/yiisoft/rbac-cycle-db/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/rbac-cycle-db/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/7c51b2055719beb950741f7a43533e7aa27691073efde3f54602f51b278addf4/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f726261632d6379636c652d64622f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/rbac-cycle-db) The package provides [Cycle Database](https://github.com/cycle/database) storage for [Yii RBAC](https://github.com/yiisoft/rbac). Detailed build statuses: RDBMSStatusSQLite[![SQLite status](https://github.com/yiisoft/rbac-cycle-db/workflows/sqlite/badge.svg)](https://github.com/yiisoft/rbac-cycle-db/actions?query=workflow%3Asqlite)MySQL[![MYSQL status](https://github.com/yiisoft/rbac-cycle-db/workflows/mysql/badge.svg)](https://github.com/yiisoft/rbac-cycle-db/actions?query=workflow%3Amysql)PostgreSQL[![PostgreSQL status](https://github.com/yiisoft/rbac-cycle-db/workflows/pgsql/badge.svg)](https://github.com/yiisoft/rbac-cycle-db/actions?query=workflow%3Apgsql)Microsoft SQL Server[![Microsoft SQL Server status](https://github.com/yiisoft/rbac-cycle-db/workflows/mssql/badge.svg)](https://github.com/yiisoft/rbac-cycle-db/actions?query=workflow%3Amssql)Requirements ------------ [](#requirements) - PHP 8.1 or higher. - In the case of using with SQLite, a minimal required version is 3.8.3. - 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: ``` composer require yiisoft/rbac-cycle-db ``` General usage ------------- [](#general-usage) ### Configuring database connection [](#configuring-database-connection) Configuration depends on a selected driver. Here is an example for PostgreSQL: ``` use Cycle\Database\Config\DatabaseConfig; use Cycle\Database\Config\Postgres\DsnConnectionConfig; use Cycle\Database\Config\PostgresDriverConfig; use Cycle\Database\DatabaseManager; $dbConfig = new DatabaseConfig( [ 'default' => 'default', 'databases' => [ 'default' => ['connection' => 'pgsql'], ], 'connections' => [ 'pgsql' => new PostgresDriverConfig(new DsnConnectionConfig( 'pgsql:host=127.0.0.1;dbname=yiitest;port=5432', 'user', 'password', )), ], ] ); $databaseManager = new DatabaseManager($dbConfig); $database = $databaseManager->database(); ``` More comprehensive examples can be found at [Cycle Database docs](https://cycle-orm.dev/docs/database-configuration#declare-connection). ### Working with migrations [](#working-with-migrations) This package uses [Cycle Migrations](https://github.com/cycle/migrations) 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 migrator and capsule [](#configuring-migrator-and-capsule) ``` use Cycle\Database\DatabaseManager; use Cycle\Migrations\Capsule; use Cycle\Migrations\Config\MigrationConfig; use Cycle\Migrations\FileRepository; use Cycle\Migrations\Migrator; $migrationsSubfolders = ['items', 'assignments']; $directories = array_map( static fn (): string => dirname(__DIR__. 2), "/vendor/yiisoft/rbac-cycle-db/migrations/$subfolder", $migrationsSubfolders, ); $config = new MigrationConfig([ 'directory' => $directories[0], // "vendorDirectories" are specified because the "directory" option doesn't support multiple directories. In the // end, it makes no difference because they all will be merged into a single array. 'vendorDirectories' => $directories[1] ?? [], 'table' => 'cycle_migration', 'safe' => true, ]); /** @var DatabaseManager $databaseManager */ $migrator = new Migrator($config, $databaseManager, new FileRepository($config)); $migrator->configure(); $capsule = new Capsule($databaseManager->database()); ``` For configuring `$databaseManager`, see [previous section](#configuring-database-connection). 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, adjust `$migrationsSubfolders` variable like this: ``` $migrationsSubfolders = ['assignments']; ``` #### Applying migrations [](#applying-migrations) ``` use Cycle\Migrations\Capsule; use Cycle\Migrations\Migrator; /** * @var Migrator $migrator * @var Capsule $capsule */ while ($migrator->run($capsule) !== null) { echo "Migration {$migration->getState()->getName()} applied successfully.\n"; } ``` #### Reverting migrations [](#reverting-migrations) ``` use Cycle\Migrations\Capsule; use Cycle\Migrations\Migrator; /** * @var Migrator $migrator * @var Capsule $capsule */ while ($migrator->rollback($capsule) !== null) { echo "Migration {$migration->getState()->getName()} reverted successfully.\n"; } ``` ### 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 Cycle\Database\DatabaseInterface; use Yiisoft\Rbac\Cycle\AssignmentsStorage; use Yiisoft\Rbac\Cycle\ItemsStorage; use Yiisoft\Rbac\Cycle\TransactionalManagerDecorator; use Yiisoft\Rbac\Manager; use Yiisoft\Rbac\Permission; use Yiisoft\Rbac\RuleFactoryInterface; /** @var DatabaseInterface $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 file](https://github.com/yiisoft/rbac-php) while store 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 Cycle\Migrations\Migration; final class DeletePostUpdateItems extends Migration { private const TABLE_PREFIX = 'yii_rbac_'; private const ASSIGNMENTS_TABLE = self::TABLE_PREFIX . 'assignment'; public function up() { $this ->database() ->delete() ->from(self::ASSIGNMENTS_TABLE) ->where('item_name', 'IN', ['posts.redactor', 'posts.update']); } public function down() { } } ``` 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 Cycle 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 43 — FairBetter than 91% of packages Maintenance43 Moderate activity, may be stable Popularity38 Limited adoption so far Community26 Small or concentrated contributor base Maturity57 Maturing project, gaining track record 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 ~182 days Total 3 Last Release 802d ago Major Versions 1.0.0 → 2.0.02023-04-20 2.0.0 → 3.0.02024-03-07 PHP version history (2 changes)1.0.0PHP ^8.0 3.0.0PHP ^8.1 ### 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 (44 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (21 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (10 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (9 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (7 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (4 commits)")[![razonyang](https://avatars.githubusercontent.com/u/17720932?v=4)](https://github.com/razonyang "razonyang (3 commits)")[![thenotsoft](https://avatars.githubusercontent.com/u/44147615?v=4)](https://github.com/thenotsoft "thenotsoft (2 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (2 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (2 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)") --- Tags cycledatabasehacktoberfestrbacspiralyii3storagerbacyiicyclecycle-db ### Code Quality TestsPHPUnit Static AnalysisPsalm, Rector Type Coverage Yes ### Embed Badge ![Health badge](/badges/yiisoft-rbac-cycle-db/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-rbac-cycle-db/health.svg)](https://phpackages.com/packages/yiisoft-rbac-cycle-db) ``` ### Alternatives [yiisoft/yii Yii Web Programming Framework 4.8k5.6M262](/packages/yiisoft-yii)[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/yii-cycle Cycle ORM v2 support 47115.1k](/packages/yiisoft-yii-cycle)[yiisoft/rbac-php Yii RBAC PHP File Storage 2472.4k1](/packages/yiisoft-rbac-php)[yiisoft/rbac-db Yii RBAC Database storage 198.1k1](/packages/yiisoft-rbac-db)[yiisoft/rbac Yii Role-Based Access Control 76148.4k9](/packages/yiisoft-rbac) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)