https://github.com/yiisoft/access
Access checking abstraction
https://github.com/yiisoft/access
access hacktoberfest interface yii3
Last synced: 9 months ago
JSON representation
Access checking abstraction
- Host: GitHub
- URL: https://github.com/yiisoft/access
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2019-05-29T14:57:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-10T09:22:25.000Z (11 months ago)
- Last Synced: 2025-04-10T20:39:37.270Z (9 months ago)
- Topics: access, hacktoberfest, interface, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 90.8 KB
- Stars: 31
- Watchers: 18
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Access
[](https://packagist.org/packages/yiisoft/access)
[](https://packagist.org/packages/yiisoft/access)
[](https://github.com/yiisoft/access/actions/workflows/build.yml)
[](https://codecov.io/gh/yiisoft/access)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/access/master)
[](https://github.com/yiisoft/access/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/access)
This package provides an interface for checking if certain user has certain permission. Optional parameters could be passed
for fine-grained access checks. Additionally, `DenyAll` and `AllowAll` implementations are available out of the box.
## Requirements
- PHP 8.0 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/access
```
## General usage
An access checker [such as RBAC](https://github.com/yiisoft/rbac) implements the interface. A user identity may use it
then for checking access:
```php
use Yiisoft\Access\AccessCheckerInterface;
class UserService
{
private AccessCheckerInterface $accessChecker;
public function __construct(AccessCheckerInterface $accessChecker)
{
$this->accessChecker = $accessChecker;
}
public function can(string $permissionName, array $parameters = []): bool
{
return $this->accessChecker->userHasPermission(
$this
->getCurrentUser()
->getId(),
$permissionName,
$parameters
);
}
public function getCurrentUser(): User
{
// ...
}
}
```
In the handler it may look like the following:
```php
public function actionList(UserService $userService)
{
if (!$userService->can('list_posts')) {
// access denied
}
// list posts
}
```
## 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 Access 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)