README

Um pacote PHP simples, elegante e eficiente para controle de acesso baseado em funções (Roles) e permissões (Permissions) usando PDO.

Requisitos

• PHP >= 7.4
• Banco de dados MySQL ou qualquer banco de dados compatível com PDO

Instalação

Adicione o repositório ou instale localmente via Composer:

composer require felipe-etec/simple-php-acl

Configuração do Banco de Dados

Você tem duas formas de configurar as tabelas do banco de dados no seu projeto:

Opção 1: Criação Automática (Recomendada)

Você pode chamar o método estático createTables logo após instanciar a conexão PDO (por exemplo, em um script de instalação ou migration):

use FelipeEtec\SimpleAcl\ACL;

$pdo = new PDO("mysql:host=localhost;dbname=seu_banco", "usuario", "senha");

// Cria todas as tabelas necessárias automaticamente
ACL::createTables($pdo);

Opção 2: SQL Manual

Se preferir, crie as tabelas manualmente rodando este script SQL:

CREATE TABLE `users` (
    `id` INT AUTO_INCREMENT PRIMARY KEY,
    `name` VARCHAR(100) NOT NULL,
    `email` VARCHAR(100) UNIQUE NOT NULL,
    `password` VARCHAR(255) NOT NULL,
    `created_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

CREATE TABLE `roles` (
    `id` INT AUTO_INCREMENT PRIMARY KEY,
    `name` VARCHAR(50) UNIQUE NOT NULL,
    `description` VARCHAR(255) NULL
);

CREATE TABLE `permissions` (
    `id` INT AUTO_INCREMENT PRIMARY KEY,
    `name` VARCHAR(100) UNIQUE NOT NULL,
    `description` VARCHAR(255) NULL
);

CREATE TABLE `role_permissions` (
    `role_id` INT,
    `permission_id` INT,
    PRIMARY KEY (`role_id`, `permission_id`),
    FOREIGN KEY (`role_id`) REFERENCES `roles`(`id`) ON DELETE CASCADE,
    FOREIGN KEY (`permission_id`) REFERENCES `permissions`(`id`) ON DELETE CASCADE
);

CREATE TABLE `user_roles` (
    `user_id` INT,
    `role_id` INT,
    PRIMARY KEY (`user_id`, `role_id`),
    FOREIGN KEY (`user_id`) REFERENCES `users`(`id`) ON DELETE CASCADE,
    FOREIGN KEY (`role_id`) REFERENCES `roles`(`id`) ON DELETE CASCADE
);

Como Usar

1. Validando Permissões e Funções

use FelipeEtec\SimpleAcl\ACL;

$acl = new ACL($pdo, $userId);

// Verificar permissão
if ($acl->hasPermission('excluir_conteudo')) {
    // Ação autorizada
}

// Verificar função
if ($acl->hasRole('Administrador')) {
    // Painel administrativo
}

2. Gerenciando Funções e Permissões (Dar e Revogar Acesso)

O pacote oferece métodos robustos para administrar funções e permissões programaticamente:

// 1. Criar uma nova função e uma permissão
$roleId = $acl->createRole('Editor Senior', 'Pode revisar e publicar artigos');
$permissionId = $acl->createPermission('publicar_artigo', 'Permissão para publicar artigos');

// 2. Associar a permissão a esta função
$acl->addPermissionToRole($roleId, $permissionId);

// 3. Atribuir a função a um usuário
$acl->assignRoleToUser($userId, $roleId);

// 4. Revogar papel ou permissão
$acl->removeRoleFromUser($userId, $roleId);
$acl->removePermissionFromRole($roleId, $permissionId);

Licença

Este projeto está licenciado sob a licença MIT.