Download the PHP package greggilbert/redoubt without Composer
On this page you can find all versions of the php package greggilbert/redoubt. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download greggilbert/redoubt
More information about greggilbert/redoubt
Files in greggilbert/redoubt
Package redoubt
Short Description A resource-level ACL for Laravel 4.
License MIT
Homepage http://github.com/greggilbert/redoubt
Informations about the package redoubt
NOT MAINTAINED.
This is an L4 package and won't be updated for L5, or at any point in the future. If you're looking for a more up to date package, try BeatSwitch/lock.
Redoubt
A resource-level ACL for Laravel 4. Based on and inspired by lukaszb/django-guardian, an excellent Django library.
Note: this in active development. The interfaces won't change, but there will be more functionality added in within the next few months.
Installation
Add the following line to the require
section of composer.json
:
Setup
- Add
Greggilbert\Redoubt\RedoubtServiceProvider
to the service provider list inapp/config/app.php
. - Add
'Redoubt' => 'Greggilbert\Redoubt\Facades\Redoubt',
to the list of aliases inapp/config/app.php
. - If you're using Eloquent, run
php artisan migrate --package=greggilbert/redoubt
. - OPTIONAL: If you plan to override any of the base classes (e.g. User), run
php artisan config:publish greggilbert/redoubt
.
Usage
Redoubt offers two levels of permissions: users and groups. Users and groups can be given access to resources, and users can be associated to groups. Each resouce must have permission defined on it.
Redoubt uses Laravel's built-in polymorphic relations to handle its associations, so all you have to do is pass in the actual model.
On resources
Resources need to implement Greggilbert\Redoubt\Permission\PermissibleInterface
, which defines one method, getPermissions()
. The method needs to return an array where the key is the permission, and the value is the description:
This MUST be defined for each method; trying to associate a permission on a resource where the permission is not already defined will throw an error.
To create a group:
To create an admin group, add 'is_admin' => true,
into the create()
statement.
To associate a user to a resource:
allowUser()
has a third parameter for a user; if it's not defined, it will default to the current one used by Laravel's Auth
.
To deassociate a user to a resource:
To associate a group to a resource:
To deassociate a group to a resource:
To associate a user to a group:
If you're using the default configuration, Users and Groups are Eloquent models, so you would do:
To check if a user has access:
Redoubt::userCan()
checks if the user has access or if they're in any groups that have that access. This function will return true
for user who is in any admin groups.
To get all permissions that a user has:
getPermissions()
can take three parameters: a user, an object, and a permission. All of these parameters are optional. If the first parameter is left as null, it will use the current user.
The following would get all the permissions the current user has for Articles.
Similarly, this would get all the permissions the current user has for editing Articles.
You can pass in an Article object for the second parameter as well.
To get users who have permissions to an object:
Note that this will return UserObjectPermission models; you'll need to then call ->getUser()
to get the user.
To get groups who have permissions to an object:
Note that this will return GroupObjectPermission models; you'll need to then call ->getGroup()
to get the group.
Other functions
To check if a user is in a group:
$groups
should be an array of Group
objects.
To get users in a group:
This will return a collection of User
objects.
Extension
Redoubt has a built-in User class, but if you want to extend it to use on your own, either extend Greggilbert\Redoubt\User\EloquentUser
or implement the Greggilbert\Redoubt\User\UserInterface
interface. You'll also need to publish the config for the package and change the user model listed there.