Skip to content

Commit

Permalink
Fix docs (#40)
Browse files Browse the repository at this point in the history
Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>
  • Loading branch information
luizcmarin and vjik authored May 22, 2024
1 parent e4b1908 commit 236b868
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<a href="https://github.com/yiisoft" target="_blank">
<img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px">
<img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px" alt="Yii">
</a>
<h1 align="center">Yii RBAC Rules Container</h1>
<br>
Expand All @@ -15,8 +15,8 @@
[![static analysis](https://github.com/yiisoft/rbac-rules-container/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/rbac-rules-container/actions?query=workflow%3A%22static+analysis%22)
[![type-coverage](https://shepherd.dev/github/yiisoft/rbac-rules-container/coverage.svg)](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
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.

Expand Down Expand Up @@ -57,12 +57,12 @@ $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
- `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
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.
Expand Down
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@
"license": "BSD-3-Clause",
"support": {
"issues": "https://github.com/yiisoft/rbac-rules-container/issues?state=open",
"source": "https://github.com/yiisoft/rbac-rules-container",
"forum": "https://www.yiiframework.com/forum/",
"wiki": "https://www.yiiframework.com/wiki/",
"irc": "ircs://irc.libera.chat:6697/yii",
"chat": "https://t.me/yii3en",
"source": "https://github.com/yiisoft/rbac-rules-container"
"chat": "https://t.me/yii3en"
},
"funding": [
{
Expand Down

0 comments on commit 236b868

Please sign in to comment.