onix-systems-php/hyperf-policy

Policy library for hyperf

v1.2.0 2023-12-05 18:35 UTC

Requires

• php: >=8.1
• hyperf/constants: ^3.1
• hyperf/di: ^3.1
• hyperf/server: ^3.1
• hyperf/testing: ^3.1
• onix-systems-php/hyperf-core: >=1.2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• mockery/mockery: ^1.0
• phpstan/phpstan: ^1.0
• phpunit/phpunit: >=7.0
• swoole/ide-helper: ^4.5|^5.0

Suggests

• swow/swow: Required to create swow components.

MIT

• php
• authorization
• Policy
• hyperf

README

Uses Symfony-like voters to check permissions

Install:

composer require onix-systems-php/hyperf-policy

To make it works, you need:

1. create policy class based on OnixSystemsPHP\HyperfPolicy\Policy\AbstractPolicy

2. add OnixSystemsPHP\HyperfPolicy\Annotation\Policy annotation to the policy and setup it's priority (higher number executes first)

3. specify what classes\objects and actions your policy will work with

4. specify vote logic and return one of the values:

   1. PolicyVote::ACCESS_DENIED - stop execution and throw exception specified in getException method
   2. PolicyVote::ACCESS_GRANTED - allow current action and skip all following policies
   3. PolicyVote::ACCESS_ABSTAIN - go to next policy, allow action if no policies left to check

5. create data specifier class based on OnixSystemsPHP\HyperfPolicy\Policy\AbstractDataSpecifier

6. add OnixSystemsPHP\HyperfPolicy\Annotation\DataSpecifier annotation to the specifier and setup it's priority (higher number executes first)

7. specify what repositories and actions your specifier will work with