vsch/user-privilege-mapper

A Laravel Service Provider to handle testing of available user security privileges independent of User Model implementation

2.0.5 2016-02-13 17:27 UTC

Requires

• php: >=5.4.0
• illuminate/support: ~5.0

MIT

• Vladimir Schneider

• Authentication
• auth
• laravel

README

This package implements a simple Service Provider that enables mapping of user privileges independent of the implementation of the User model. It uses Laravel macros() to create an interface between a user privilege test and the actual implementation of the code to check whether the current user has this privilege enabled.

I use this package to allow my other packages to test for security privileges without having to dictate how the user model is defined within a project.

For Laravel 4 use the Laravel4 branch, or require: "vsch/user-privilege-mapper": "~1.0"

For Laravel 5 use the master branch, or require: "vsch/user-privilege-mapper": "~2.0"

Installation

1. Require this package in your composer.json and run composer update (or run composer require vsch/user-privilege-mapper:* directly):

    "vsch/user-privilege-mapper": "~2.0"
   

2. After updating composer, add the ServiceProviders to the providers array in config/app.php

    Vsch\UserPrivilegeMapper\UserPrivilegeMapperServiceProvider::class,
   

3. add the Facade to the aliases array in config/app.php:

    'UserCan'   => Vsch\UserPrivilegeMapper\Facade\Privilege::class,
   

4. To create a mapping layer between your User model implementation and the need to test user privileges without knowing the implementation. You need to create named privileges for the UserPrivilegeMapper via the Laravel macro mechanism. This should be done in the initialization files.

   A good place is the app/Providers/AppServiceProvider.php file, add the following to the boot() function, if your User model has is_admin and is_editor attributes to identify users that have Admin and Editor privileges or just return true in both cases, if you don't have any way of determining user privileges:

    \UserCan::macro("admin", function ()
    {
        return ($user = Auth::user()) && $user->is_admin;
    });
    
    \UserCan::macro("edit", function ()
    {
        return ($user = Auth::user()) && ($user->is_admin || $user->is_editor);
    });
   

5. Testing whether a privilege is available is as simple as:

    if (\UserCan::admin())
    {
        // user has admin privileges
    }
    elseif (\UserCan::edit())
    {
        // user has edit privileges
    }
   

   If a macro was not previously defined then the privilege test will return false. Effectively, if the macro is not implemented then the privilege is treated as not existent for every user.

The implementation is more of a convention that is implemented by Laravel's Macroable trait. I don't see this package changing unless I get an epiphany. So consider this package code complete. However, suggestions are appreciated and welcome. :)