README

Integração do pacote Spatie Laravel Permission com o framework Luminix Backend, adicionando validação automática, observadores e descoberta de modelos.

Requisitos

PHP 8.2+
Laravel 11.x
spatie/laravel-permission ^6.24
luminix/backend

Instalação

composer require luminix/laravel-permission-integration

Configuração

Registrar os modelos na configuração de permissões

Após instalar o pacote, você precisa informar ao Spatie Laravel Permission que deve utilizar os modelos fornecidos por este pacote. Publique o arquivo de configuração do Spatie (caso ainda não o tenha feito) e registre os modelos:

php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider"

Em seguida, edite o arquivo config/permission.php e altere a seção models:

// config/permission.php

use Luminix\LaravelPermissionIntegration\Models\Permission;
use Luminix\LaravelPermissionIntegration\Models\Role;

return [

    'models' => [

        'permission' => Permission::class,

        'role' => Role::class,

    ],

    // ...restante da configuração
];

Importante: sem este passo, o pacote não funcionará corretamente — os modelos padrão do Spatie serão utilizados no lugar dos modelos estendidos por esta integração.

Publicar a configuração do pacote

Para personalizar o comportamento do pacote, publique o arquivo de configuração:

php artisan vendor:publish --tag=luminix-config

Isso cria o arquivo config/luminix/permission.php:

Funcionalidades

Modelos estendidos

Os modelos Role e Permission estendem os modelos padrão do Spatie e adicionam:

Validação automática via atributo PHP #[WithValidator]
Observadores via atributo PHP #[ObservedBy]
Integração com o Luminix Backend através da trait LuminixModel

Role

Valida os campos name, guard_name e o array de permissions ao criar ou atualizar
Sincroniza automaticamente as permissões associadas ao salvar (via RoleObserver)
Eager-loading de permissões via escopo scopeBeforeLuminix

Permission

Valida os campos name e guard_name ao criar ou atualizar

Sincronização de permissões em roles

Ao salvar uma função (role) com um array de permissões no corpo da requisição, o observador sincroniza automaticamente as permissões associadas:

Observação: a associação de permissões só estará disponível para usuários que possuam autorização para create-role (ao criar) ou update-role (ao atualizar).

POST /luminix-api/roles
{
    "name": "editor",
    "guard_name": "web",
    "permissions": ["create-post", "update-post"]
}

Sincronização de roles em modelos de usuário

Para modelos que utilizam a trait HasRoles do Spatie, as roles serão sincronizadas automaticamente:

PUT /luminix-api/users/1
{
    "name": "João",
    "roles": ["editor", "moderador"]
}

Observação: a sincronização só ocorre para usuários que possuam a permissão definida em luminix.permission.permission_to_set_roles (padrão: set-roles). Defina como null para permitir a todos.

Guards

O campo guard_name é validado contra os guards configurados em config/auth.php. Para acessar os guards disponíveis programaticamente:

use Luminix\LaravelPermissionIntegration\Facades\Integration;

$guards = Integration::getAvailableGuards();

Descoberta de modelos

O PermissionServiceProvider registra automaticamente os modelos Role e Permission no ModelFinder do Luminix Backend, tornando-os disponíveis para as operações CRUD geradas pelo framework.

Limitações

O pacote ainda não está preparado para lidar com as nuances de um sistema que usa múltiplas guardas. Por enquanto, é recomendado usar apenas em projetos onde apenas uma única guarda é usada.

Comandos

`luminix:api-permissions`

Cria as permissões CRUD para todos os modelos descobertos pelo Luminix Backend. Use este comando após adicionar novos modelos à aplicação para garantir que as permissões correspondentes existam no banco de dados.

php artisan luminix:api-permissions --guard=web

O comando aceita múltiplos guards:

php artisan luminix:api-permissions --guard=web --guard=api

Para cada modelo encontrado, o comando criará as permissões create-{model}, read-{model}, update-{model} e delete-{model}. O comando é idempotente — executá-lo múltiplas vezes não cria duplicatas.

Exemplo — para uma aplicação com os modelos User, Post, Role e Permission, o comando criaria:

create-user, read-user, update-user, delete-user
create-post, read-post, update-post, delete-post
create-role, read-role, update-role, delete-role
create-permission, read-permission, update-permission, delete-permission

Uso com usuários

Este pacote é compatível com todos os recursos do Spatie Laravel Permission. Adicione a trait HasRoles ao seu model de usuário:

use Spatie\Permission\Traits\HasRoles;

class User extends Authenticatable
{
    use HasRoles;
}

Em seguida, utilize normalmente:

$user->assignRole('editor');
$user->hasRole('editor');
$user->can('update-post');

Licença

MIT

luminix / laravel-permission-integration

Maintainers

Package info

Statistics

Security