Download the PHP package railken/amethyst-permission without Composer
On this page you can find all versions of the php package railken/amethyst-permission. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package amethyst-permission
amethyst-permission
Amethyst package.
Define permissions with an extensive customization for your data and routes.
Requirements
PHP 7.2 and later.
TODO
- [ ] Attribute Authorization
Installation
You can install it via Composer by typing the following command:
The package will automatically register itself.
Usage
A simple usage looks like this
Permissions will be automatically reloaded whenever a eloquent.saved
is fired for Permission
model.
Effect
The effect can be either accept
or deny
. Without any permissions any user is denied to perform anything. If you add both permission accept and deny both of them are applied.
For example you could set "user can see all comments" and "user cannot see this comment". At the end the user can see all comments except the one that you defined.
Type
The type of your permission indicate which class will be used to resolve your request.
It can be either data
or route
, but you can extend it in amethyst.permissions.permission
Agent
The agent is retrieved through the facade Illuminate\Support\Facades\Auth
and the method user()
.
When this field is null it means that it's applied to all agents.
Agent must return a condition true or false.
If you wish to see the syntax see nicoSWD/php-rule-parser.
Before parsing with the logic parser, a twig parser comes in. The only variable passed is the agent and it is your App\Models\User
. You can then use whanever logic you want to get the information you want. For example you can filter by any attributes and any relations (e.g. groups): {{ agent.groups.contains('myGroupName') ? 1 : 0 }} === 1
Payload
A payload in YAML the define the specification of your permission. For example for the permission route
it can be a wildcard for the url.
Payload - Route
- name: The name of the route you wish to use, you can use wildcard
*
- url: The url of the route, same like before, you can use the wildcard
*
, - method: The method of the route
Some examples:
Enable endpoint /profile
for each user.
You can also use an array
Enable endpoints foo.* (foo.index, foo.create, foo.show, foo.update, foo.delete) for user id 2
Payload - Data
The following example will permit the user#2 to visualize only the data named post
that contains in the name foo
List of all actions: query, create, update, remove
All versions of amethyst-permission with dependencies
amethyst/core Version 0.3.*
amethyst/owner Version 0.3.*
railken/template Version ^1.1
nicoswd/php-rule-parser Version ^0.7.1