Download the PHP package getpop/access-control without Composer
On this page you can find all versions of the php package getpop/access-control. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download getpop/access-control
More information about getpop/access-control
Files in getpop/access-control
Package access-control
Short Description Access Control for schema elements
License GPL-2.0-or-later
Homepage https://github.com/getpop/access-control
Informations about the package access-control
Access Control
Access Control for schema elements
Install
Via Composer
Development
The source code is hosted on the GatoGraphQL monorepo, under Engine/packages/access-control
.
Usage
Initialize the component:
How does it work?
Access control deals in 2 modes: Public/Private schema modes.
The difference between Public and Private schema modes concerns the feedback given to the user when a validation fails. In Public mode, a detailed error message is given to the user (eg: "only users with role 'administrator' can access this field). In Private mode, there is no helpful information, instead the user is told that the field or directive does not exist.
We need to implement 4 cases of access control:
- Fields in Public schema mode
- Directives in Public schema mode
- Fields in Private schema mode
- Directives in Private schema mode
In Public schema mode, we can simply add a special directive that will validate the restriction (such as: is the user logged in? does the logged-in user have a specific role or capability?).
In Private mode, we add a hook that filters out the field or directive before it is registered.
In addition, whenever a validation must be performed to know if the user can access a field or directive, the response from the GraphQL server cannot be cached (when using component Cache Control). For the Public mode this situation is automatically handled, since the directive validating if the user is logged in or not already indicates that the response cannot be cached. For the Private mode, however, we need to add a special directive "NoCache"
. Hence, we need to deal with the following 2 cases:
NoCache
for Fields in Private schema modeNoCache
for Directives in Private schema mode
PHP versions
Requirements:
- PHP 8.1+ for development
- PHP 7.4+ for production
Supported PHP features
Check the list of Supported PHP features in GatoGraphQL/GatoGraphQL
Preview downgrade to PHP 7.4
Via Rector (dry-run mode):
Standards
To check the coding standards via PHP CodeSniffer, run:
To automatically fix issues, run:
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
To execute PHPUnit, run:
Static Analysis
To execute PHPStan, run:
Report issues
To report a bug or request a new feature please do it on the GatoGraphQL monorepo issue tracker.
Contributing
We welcome contributions for this package on the GatoGraphQL monorepo (where the source code for this package is hosted).
Please see CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Leonardo Losoviz
- All Contributors
License
GNU General Public License v2 (or later). Please see License File for more information.