https://github.com/ojhaujjwal/userrbac

A Zend Framework 2 module to easily integrate ZfcUser and ZfcRbac
https://github.com/ojhaujjwal/userrbac

Last synced: 17 days ago
JSON representation

A Zend Framework 2 module to easily integrate ZfcUser and ZfcRbac

• Host: GitHub
• URL: https://github.com/ojhaujjwal/userrbac
• Owner: ojhaujjwal
• License: mit
• Created: 2014-02-01T15:24:14.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-08-13T13:08:24.000Z (over 10 years ago)
• Last Synced: 2024-04-22T01:42:39.692Z (7 months ago)
• Language: PHP
• Size: 477 KB
• Stars: 7
• Watchers: 4
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
UserRbac

========

[![Master Branch Build Status](https://api.travis-ci.org/ojhaujjwal/UserRbac.png)](http://travis-ci.org/ojhaujjwal/UserRbac)

[![Latest Stable Version](https://poser.pugx.org/ujjwal/user-rbac/v/stable.png)](https://packagist.org/packages/ujjwal/user-rbac)

[![Latest Unstable Version](https://poser.pugx.org/ujjwal/user-rbac/v/unstable.png)](https://packagist.org/packages/ujjwal/user-rbac)

[![Total Downloads](https://poser.pugx.org/ujjwal/user-rbac/downloads.png)](https://packagist.org/packages/ujjwal/user-rbac)

[![Scrutinizer](https://scrutinizer-ci.com/g/ojhaujjwal/UserRbac/badges/quality-score.png?s=cb02df4e08a5df08c1ec74d1e483fbd347da154f)](https://scrutinizer-ci.com/g/ojhaujjwal/UserRbac/)

[![Code Coverage](https://scrutinizer-ci.com/g/ojhaujjwal/UserRbac/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/ojhaujjwal/UserRbac/?branch=master)

A Zend Framework 2 module to easily integrate [ZfcUser](https://github.com/ZF-Commons/ZfcUser) and [ZfcRbac](https://github.com/ZF-Commons/zfc-rbac)

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.

## 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 `"ujjwal/user-rbac": "0.1.*",` to your composer.json and run `php composer.phar update`

* Import the schema in `data/mysql.sql`

* Enable this module in `config/application.config.php`

* Copy file located in `vendor/ujjwal/user-rbac/config/user-rbac.global.php` 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`](https://github.com/ojhaujjwal/UserRbac/blob/master/config/module.config.php#L4).

 

## 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/ujjwal/user-rbac/config/user-rbac.global.php`. 

## 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

```php

public function onBootstrap(EventInterface $e)

{

    $t = $e->getTarget();

    $t->getEventManager()->attach(

        $t->getServiceManager()->get('UserRbac\View\Strategy\SmartRedirectStrategy')

    );

}

```

## Known Limitation

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