winponta/cani

Cani (Can I)

Cani, or "Can I" project, is a Laravel 5 project that implement a simple ACL based on noSql databases. The first implementation is focused on MongoDB, using jenssegers/mongodb driver., _(*1)

This project is fully based on https://github.com/spatie/laravel-permission package., _(*2)

Warning

WIP -- this project is in its initial development, please come back in a few days, _(*3)

** This project is tested on Laravel 5.2 version, not sure if all features work on 5.1. **, _(*4)

Installation

In composer.json, _(*5)

"require": {
        ...
        "winponta/cani": "0.0.*",
        ...
    },

Then run composer update., _(*6)

In config/app.path at providers section, _(*7)

Winponta\Cani\Providers\CaniServiceProvider::class,, _(*8)

In the same file, under the aliases array, you may want to add the Cani Facade., _(*9)

'Cani' => Winponta\Cani\Facades\Cani::class,, _(*10)

Save the file and then run:, _(*11)

php artisan vendor:publish --provider="Winponta\Cani\Providers\CaniServiceProvider", _(*12)

This command will publish the cani's config file inside your config directory., _(*13)

Configuration

Inside the config/cani.php you'll have the following options:, _(*14)

Models

Permission

Which Eloquent Model should be used to retrieve your permissions. Your model must implement the Winponta\Cani\Contracts\Permission contract., _(*15)

Role

Which model should be used to retrieve your roles. Your model must implement the Winponta\Cani\Contracts\Role contract., _(*16)

Collections

Users

The collection your application uses for users. This collection's model will be using the CanHavePermissions and CanHaveRoles traits., _(*17)

Roles

The collection your application uses for roles. When using the CanHaveRoles trait we need to know which collection should be used to retrieve your roles., _(*18)

Permissions

The collection your application uses for permissions. When using the CanHavePermissions trait we need to know which collection should be used to retrieve your permissions., _(*19)