README

A simple Role/Permission based auth package for Laravel4

Roles
Permissions
Exceptions
Route filters

Installation

Just place require new package for your laravel installation via composer.json

"edvinaskrucas/rbauth": "dev-master"

Then hit composer update after update you should migrate rbauth package by hitting php artisan migrate --package=edvinaskrucas/rbauth

Registering it in Laravel

Add following lines to app/config/app.php

ServiceProvider array

'Krucas\RBAuth\RBAuthServiceProvider'

Change auth driver to rbauth in app/config/auth.php

Now you are able to use it with Laravel4.

Config

If you want to use your own implementations of interfaces you need to publish package config file by using php artisan config:publish edvinaskrucas/rbauth Now you will be able to change default implementations i a file: app/config/packages/edvinaskrucas/rbauth/

Usage

Basic examples

Sample RoleInterface and RoleProviderInterface implementations are included, but method can($identifier) must be implemented by user.

Logging in a user

$input = Input::all();

try
{
    Auth::attempt(
        array(
            'email' => $input['email'],
            'password' => $input['password']
        ),
        isset($input['reminder'])
    );
    return Redirect::back(); // All is ok
}
catch(UserNotFoundException $e)
{
    // User not found
}
catch(UserPasswordIncorrectException $e)
{
    // Password incorrect
}

Determine if a logged in user is in a role

Returns boolean true (if has a role assigned) or false (if has not a role assigned)

Auth::is('admin');

Determine if a logged in user has permission to a resource

Returns boolean true (if can) or false (if can not)

Auth::can('view.profile');

Extending Auth with your custom checks

Sometimes you need to check few rules on a certain object, so you can easily do that by adding your custom checks. This example shows how to check compound permissions. For example you have two permissions for editing a trip: trips.edit.all and trips.edit.own, you can use double check on a certain trip by using simple calls, or you just can use this example below.

Auth::rule('trips.edit', function($trip)
{
    if(Auth::can('trips.edit.all'))
    {
        return true;
    }
    elseif(Auth::can('trips.edit.own') && $trip->user_id == Auth::user()->id)
    {
        return true;
    }

    return false;
});

Now you can simply call method can with a new rule

if(Auth::can('trips.edit', $trip))
{
    echo 'ok';
}

Route filters

Package comes with couple route filters, one for simple check using can other for your custom checks customCan:canEditTrip

Simple example

Route::get('test', array('before' => 'can:test', function()
{
    echo 'I can test!';
}));

Now lets try using some our custom "can's"

First we need to bind some models to our routing

Route::bind('trip', function($value, $route)
{
    return Trip::find($value);
})

Now we can access our trip objects from a route.

Route::get('trips/edit/{trip}', array('before' => 'can:trips.edit,trip', function($trip)
{
    echo 'I can edit this trip!';
}));

So structure of custom route permission check is:

cam:trips.edit,trip

trips.edit - your rule name

trip - and other parameters are optional, this is usefull if you need to pass object to a custom check.
In this case (route filter) trip will be resolved from Route object, thats why we need to bind it.
When checking this in a controller or a view you can simply call it by "Auth::can('trips.edit', $trip)"

Exceptions

This auth extension throws two exceptions when you are trying to login:

\Krucas\RBAuth\UserNotFoundException - thrown when you are trying to login with non existing user. \Krucas\RBAuth\PasswordIncorrectException - thrown when password for user is incorrect.

Default implementation features

Users can be assigned to multiple roles
Roles can have assigned accesses (permission with status enabled / disabled)
Users can have assigned accesses (permission with status enabled / disabled)

edvinaskrucas / rbauth

Maintainers

Details