czim/laravel-cms-acl-module

Laravel CMS: ACL Module

CMS for Laravel - ACL module

Simple ACL module for the CMS., _(*1)

To be used to with the Laravel CMS Core., _(*2)

Installation

Add the module class to your cms-modules.php configuration file:, _(*3)

``` php 'modules' => [ // ... \Czim\CmsAclModule\AclModule::class, ],, <sub>(*4)</sub>

Add the service provider to your `cms-modules.php` configuration file:

``` php
    'providers' => [
        // ...
        Czim\CmsAclModule\Providers\CmsAclModuleServiceProvider::class,
        // ...
    ],

To publish the config:, <sub>(*5)</sub>

``` bash php artisan vendor:publish, <sub>(*6)</sub>

## Configuration

Available permissions are read from the [core](https://github.com/czim/laravel-cms-core)'s module defined ACL presences.

Any custom permission keys may be added to the `cms-acl-module.php` configuration file, under `permissions`:

```php
<?php
    'permissions' => [
        'example.custom.permission',
        'and.another',
    ],

Without further configuration, these will be presented under the header of 'Miscellaneous' in the permissions list selectable for roles., <sub>(*7)</sub>

To assign custom permissions, or even permissions provided by modules to a (new) permission group, use the groups configuration array., <sub>(*8)</sub>

For instance:, <sub>(*9)</sub>

<?php
    'groups' => [
        [
            // The type must always be 'group'
            'type'        => 'group',
            // The label will be used for the multiselect optgroup
            'label'            => 'Some Label',
            // Translation key to use for a label for the optgroup. If this is set, the label value is ignored. 
            'label_translated' => 'some.translation.key',
            // Permissions should always be a list of available permission slug strings
            'permissions' => [
                'example.custom.permission',
                'models.app-models-post.show',
            ]
        ]
    ],

This would assign two permissions to a new group., <sub>(*10)</sub>

Any group left without permissions will automatically be hidden, whether it is module defined or not., <sub>(*11)</sub>

For all configuration options, see the configuration file., <sub>(*12)</sub>

API Documentation

The documentation for the ACL module API endpoints: https://czim.github.io/laravel-cms-acl-module, <sub>(*13)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*14)</sub>

Credits

• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*15)</sub>