rarog/user-rbac

A Zend Framework module to easily integrate ZfcUser and ZfcRbac

v2.0.0 2018-04-19 06:14 UTC

Requires

• php: ^5.6 || ^7.0
• zf-commons/zfc-rbac: ^2.6
• zf-commons/zfc-user: ^3.0

Requires (Dev)

• php-coveralls/php-coveralls: ^2.0
• phpunit/phpunit: ^5.0 || ^6.0

MIT

• ojhaujjwal
• Andrej Sinicyn

• module
• ZendFramework
• zf3

README

A Zend Framework module to easily integrate ZfcUser and ZfcRbac

Introduction

Are your tired of doing tedious work of integrating ZfcUser and ZfcRbac again and again? Then, you are in the right place. This module comes to save us. This module, simply, gets roles of a user from the database and passes it to the ZfcRbac. You only need to focus on the domain logic of your application. No more repetive tasks.

Versions

Please use below table to figure out what version of ZfcUser you should use.

UserRbac version	Supported Zend Framework version
0.x	<= 2.5
1.x	>= 2.6 < 3
2.x	>= 3.x

Features

1. No need to write code for integrating ZfcUser and ZfcRbac
2. A user`s roles are easily retrievable from the database
3. Addition of SmartRedirectStrategy

Installation

• Add "rarog/user-rbac": "^2.0", to your composer.json and run php composer.phar update
• Import the schema for corresponding database in data folder
• Enable this module in config/application.config.php
• Copy file located in vendor/rarog/user-rbac/config/user-rbac.global.php.dist to ./config/autoload/user-rbac.global.php and change the values as you wish.

What it does

This module registers an identity provider and provides some configuration to ZfcRbac. So, you don't need to create your own identity provider. See config/module.config.php.

How it works

It gets a user's roles from the table user_role_linker and passes the roles to ZfcRbac. This module is best suited when you use ZfcRbac\Role\InMemoryRoleProvider as role provider.

Options

Check the options available in vendor/rarog/user-rbac/config/user-rbac.global.php.dist.

SmartRedirectStrategy

This module comes with a new strategy called SmartRedirectStrategy. This simply redirects to ZfcUser's login page or route, zfcuser/login only when the user is unauthenticated. Otherwise, it shows a 403 error page!

Usage

public function onBootstrap(EventInterface $e)
{
    $app = $e->getApplication();
    $sm = $app->getServiceManager();
    $em = $app->getEventManager();
    
    $listener = $sm->get(\UserRbac\View\Strategy\SmartRedirectStrategy::class);
    $listener->attach($em);
}

Known Limitation

This module is only ideal for small and medium web sites as a quick and easy way. For complicated use cases, it may not suit your need.