# rbac-rules-factory
**Repository Path**: mirrors_yiisoft/rbac-rules-factory
## Basic Information
- **Project Name**: rbac-rules-factory
- **Description**: RBAC rules container based on "yiisoft/factory".
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-12
- **Last Updated**: 2026-02-14
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
Yii RBAC Rules Container
[](https://packagist.org/packages/yiisoft/rbac-rules-container)
[](https://packagist.org/packages/yiisoft/rbac-rules-container)
[](https://github.com/yiisoft/rbac-rules-container/actions?query=workflow%3Abuild)
[](https://codecov.io/gh/yiisoft/rbac-rules-container)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/rbac-rules-container/master)
[](https://github.com/yiisoft/rbac-rules-container/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/rbac-rules-container)
This package is a factory for creating [Yii RBAC (Role-Based Access Control)](https://github.com/yiisoft/rbac) rules. It
provides rules container based on [Yii Factory](https://github.com/yiisoft/factory) and uses
[Yii Definitions](https://github.com/yiisoft/definitions) syntax. RBAC manager accepts rule as a name and parameters
and is unaware of its creation by design, delegating creation to rules container keeping responsibilities separation.
## Requirements
- PHP 8.1 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/rbac-rules-container
```
## General usage
### Direct interaction with rules container
```php
use Psr\Container\ContainerInterface;
use Yiisoft\Rbac\Item;
use Yiisoft\Rbac\RuleInterface;
use Yiisoft\Rbac\Rules\Container\RulesContainer;
/**
* Checks if user ID matches `authorID` passed via parameters.
*/
final class AuthorRule implements RuleInterface
{
public function execute(string $userId, Item $item, array $parameters = []): bool
{
return $parameters['authorID'] === $userId;
}
}
$rulesContainer = new RulesContainer(new MyContainer());
$rule = $rulesContainer->create(AuthorRule::class);
```
- `MyContainer` is a container for resolving dependencies and must be an instance of
`Psr\Container\ContainerInterface`. [Yii Dependency Injection](https://github.com/yiisoft/di) implementation also can
be used.
- You can optionally set [definitions](https://github.com/yiisoft/definitions) and disable their validation if needed.
Basically, the arguments are the same as in [Yii Factory](https://github.com/yiisoft/factory). Please refer to its docs
for more details.
Rules are created only once, then cached and reused for repeated calls.
```php
$rule = $rulesContainer->create(AuthorRule::class); // Returned from cache
```
### Using [Yii config](https://github.com/yiisoft/config)
```php
use Yiisoft\Di\Container;
use Yiisoft\Di\ContainerConfig;
use Yiisoft\Rbac\RuleFactoryInterface;
use Yiisoft\Rbac\Rules\Container\RulesContainer;
// Need to be moved to separate files accordingly
$params = [
'yiisoft/rbac-rules-container' => [
'rules' => ['author' => AuthorRule::class],
'validate' => false,
],
];
$config = [
RuleFactoryInterface::class => [
'class' => RulesContainer::class,
'__construct()' => [
'definitions' => $params['yiisoft/rbac-rules-container']['rules'],
'validate' => $params['yiisoft/rbac-rules-container']['validate'],
],
],
];
$containerConfig = ContainerConfig::create()->withDefinitions($config);
$container = new Container($containerConfig);
$rulesContainer = $container->get(RuleFactoryInterface::class);
$rule = $rulesContainer->create('author');
```
## 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
The Yii RBAC Rules Container 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
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)