README.md

Up-to-date with version 2.3.* of ZfcRbac

Welcome to the official ZfcRbac documentation. This documentation will help you quickly understand how to use and extend ZfcRbac.

If you are looking for some information that is not listed in the documentation, please open an issue!

1. Introduction

   1. Why should I use an authorization module?
   2. What is the Rbac model?
   3. How can I integrate ZfcRbac into my application?

2. Quick Start

   1. Specifying an identity provider
   2. Adding a guard
   3. Adding a role provider
   4. Registering a strategy
   5. Using the authorization service

3. Role providers

   1. What are role providers?
   2. Identity providers
   3. Built-in role providers
   4. Creating custom role providers

4. Guards

   1. What are guards and when to use them?
   2. Built-in guards
   3. Creating custom guards

5. Strategies

   1. What are strategies?
   2. Built-in strategies
   3. Creating custom strategies

6. Using the Authorization Service

   1. Injecting the AuthorizationService
   2. Checking permissions
      1. In a service
      2. In a controller's action using the isGranted controller plugin
      3. In a view using the isGranted view helper
   3. Permissions and Assertions

7. Cookbook

   1. A real world example
   2. Best practices
   3. Using ZfcRbac with Doctrine ORM
   4. How to deal with roles with lot of permissions?
   5. Using ZfcRbac and ZF2 Assetic
   6. Using ZfcRbac and ZfcUser