|
1 |
| -# Laravel Doctrine ACL |
| 1 | +<p align="center"> |
| 2 | + <img src="https://placehold.co/10x10/337ab7/337ab7.png" width="100%" height="15px"> |
| 3 | + <img width="450px" src="https://github.com/laravel-doctrine/orm/blob/3.0.x/docs/banner.png"/> |
| 4 | +</p> |
2 | 5 |
|
3 |
| -[](https://packagist.org/packages/sowl/laravel-doctrine-acl) |
4 |
| -[](https://github.com/ScholarshipOwl/laravel-doctrine-acl/actions) |
5 |
| -[](https://packagist.org/packages/sowl/laravel-doctrine-acl) |
6 |
| -[](LICENSE.md) |
| 6 | +Laravel Doctrine ACL |
| 7 | +==================== |
7 | 8 |
|
8 | 9 | Laravel Doctrine ACL is a package that provides RBAC (Role-Based Access Control) functionality for Laravel applications using Doctrine. It allows you to manage roles, permissions, and organisations, and seamlessly integrates with Laravel's Authorization system.
|
9 | 10 |
|
10 |
| -Fork of the [laravel-doctrine/acl](https://github.com/laravel-doctrine/acl) package (no longer active). |
11 |
| - |
12 |
| -## Features |
| 11 | +[](https://github.com/ScholarshipOwl/laravel-doctrine-acl/actions) |
| 12 | +[](https://codecov.io/gh/laravel-doctrine/acl) |
| 13 | +[](https://img.shields.io/badge/PHPStan-level%201-brightgreen.svg) |
| 14 | +[](https://laravel-doctrine-acl-official.readthedocs.io/en/latest/) |
| 15 | +[](https://packagist.org/packages/laravel-doctrine/acl) |
13 | 16 |
|
14 |
| -- User can have Permissions |
15 |
| -- User can have Roles |
16 |
| -- User and Roles can have Permissions |
17 |
| -- User can belong to Organisation(s) |
18 |
| -- Seamless integration with Laravel's Authorization system |
19 |
| -- PHP 8.2+ with Attributes support (annotations removed) |
| 17 | +Installation |
| 18 | +------------ |
20 | 19 |
|
21 |
| -## Installation |
| 20 | +Via composer: |
22 | 21 |
|
23 | 22 | ```bash
|
24 |
| -composer require sowl/laravel-doctrine-acl |
| 23 | +composer require laravel-doctrine/acl |
25 | 24 | ```
|
26 | 25 |
|
27 |
| -## Versions |
28 |
| - |
29 |
| -Version | Supported Laravel Versions |
30 |
| -:-------|:------ |
31 |
| - ^1.5 | 11.x |
32 |
| - ^2.0 | 12.x |
| 26 | +The ServiceProvider and Facades are autodiscovered. |
33 | 27 |
|
34 |
| -## Quick Start |
| 28 | +Publish the configuration: |
35 | 29 |
|
36 |
| -1. Publish the configuration: |
37 |
| - ```bash |
38 |
| - php artisan vendor:publish --tag="config" --provider="LaravelDoctrine\\ACL\\AclServiceProvider" |
39 |
| - ``` |
40 |
| -2. Configure your entities and relationships using PHP 8 attributes (see examples in the docs). |
41 |
| -3. Use the built-in traits and contracts to add ACL features to your User, Role, Permission, and Organisation entities. |
42 |
| - |
43 |
| -## Documentation |
44 |
| - |
45 |
| -Full documentation is available in the [`docs/`](./docs) folder. |
| 30 | +```bash |
| 31 | +php artisan vendor:publish --tag="config" --provider="LaravelDoctrine\ACL\AclServiceProvider" |
| 32 | +``` |
46 | 33 |
|
47 |
| -## Contributing |
| 34 | +Documentation |
| 35 | +------------- |
48 | 36 |
|
49 |
| -Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details and a code of conduct. |
| 37 | +Full documentation at https://laravel-doctrine-orm-official.readthedocs.io |
| 38 | +or in the docs directory. |
50 | 39 |
|
51 |
| -## License |
| 40 | +Versions |
| 41 | +-------- |
52 | 42 |
|
53 |
| -The MIT License (MIT). Please see [License File](LICENSE.md) for more information. |
| 43 | +* Version 2 supports DBAL ^4.0, ORM ^3.0, and PHP 8.2. |
| 44 | +* Version 1 supports Laravel 6 - 11, DBAL ^2.0, ORM ^2.0, and PHP ^5.5 - ^8.0. |
0 commit comments