README

Este paquete de Laravel proporciona una solución integral para la gestión de accesos en tus aplicaciones, permitiendo la definición de roles, módulos, permisos y rutas, con una lógica de relaciones muchos a muchos entre roles y permisos. Además, incluye un middleware para la validación de permisos en rutas, asegurando un control de acceso robusto y flexible.

Características Principales

Gestión de Roles: Define roles con distintos niveles de acceso, permitiendo una administración granular de privilegios.
Banco de Módulos: Organiza los permisos en módulos lógicos, facilitando la administración y comprensión de los mismos.
Banco de Permisos: Asigna permisos específicos a roles, controlando las acciones que cada rol puede realizar.
Banco de Rutas: Asocia permisos a rutas concretas, protegiendo el acceso a funcionalidades específicas de la aplicación.
Middleware de Validación: Valida los permisos de las rutas mediante un middleware, asegurando que solo los usuarios autorizados puedan acceder a ellas.
Arrancador de Capacidades: Archivo de configuración que permite el registro de modulos, permisos y rutas.
Personalización del Modelo de Usuario: Permite utilizar un modelo de usuario personalizado, adaptándose a las necesidades de cada proyecto.

Instalación

Crear grupo de paquetes:

Crear la carpeta packages en la raíz del proyecto e ingresar a la carpeta:
```
mkdir packages
cd packages
```
Crear el grupo de carpetas dentro de la carpeta creada, e ingresar a l carpeta:
```
mkdir lechuganegra
cd lechuganegra
```
Clonar el paquete:

Clonar el paquete en el grupo de carpetas creado y renombrarlo para que el Provider pueda registrarlo en la instalación
```
git clone https://github.com/mtorres-lechuganegra/package-accessmanager.git accessmanager
```

Configurar composer del proyecto:

Dirígite a la raíz de tu proyecto, edita tu archivo composer.json y añade el paquete como repositorio:

{
    "repositories": [
        {
            "type": "path",
            "url": "packages/lechuganegra/accessmanager"
        }
    ]
}

también deberás añadir el namespace del paquete al autoloading de PSR-4:

{
    "autoload": {
        "psr-4": {
            "LechugaNegra\\AccessManager\\": "packages/lechuganegra/accessmanager/src/"
        }
    }
}

Ejecutar composer require:

Después de editar tu archivo, abre tu terminal y ejecuta el siguiente comando para agregar el paquete a las dependencias de tu proyecto:
```
composer require lechuganegra/accessmanager:@dev
```
Este comando descargará el paquete y actualizará tu archivo composer.json.
Publicar archivo de configuración:

Ejecuta el siguiente comando para copiar los archivos de configuración del paquete a la carpeta config del proyecto::
```
php artisan vendor:publish --tag=accessmanager-config
```
Esto te permitirá personalizar el comportamiento del paquete desde tu proyecto.

Configurar el modelo de usuario (opcional):

Puedes editar el archivo config/accessmanager.php y modifica la entrada user_entity con la información de tu modelo:

'user_entity' => [
    'model' => App\Models\User::class, // Reemplaza con tu modelo
    'table' => 'users' // Reemplaza con el nombre de tu tabla
],

Ejecutar las migraciones:

Ejecuta las migraciones del paquete para crear las tablas necesarias en la base de datos:
```
php artisan migrate --path=packages/lechuganegra/accessmanager/src/Database/Migrations
```
Nota: Esta migración agrega un campo admin a la tabla de usuarios. Se recomienda no incluir este campo en el atributo fillable del modelo para evitar modificaciones accidentales.

Ejecutar el seeder:

Ejecuta el seeder del paquete para poblar las tablas con datos iniciales:

php artisan db:seed --class="LechugaNegra\\AccessManager\\Database\\Seeders\\DatabaseSeeder"

Limpiar la caché:

Limpia la caché de configuración y rutas para asegurar que los cambios se apliquen correctamente:
```
php artisan config:clear
php artisan config:cache
php artisan route:clear
php artisan route:cache
```
Regenerar clases:

Regenerar las clases con el cargador automático "autoload"

```bash
composer dump-autoload
```

Uso

Endpoints del Servicio

Puede importar el archivo postman_collection.json que se ubica en la carpeta docs de la raíz del paquete.

Variable de Sincronización

Puede determinar el comportamiento de la sincronización de módulos, permisos y rutas activando la siguiente variable de entorno

ACCESS_MANAGER_STRICT_SYNC=false

Esto permite hacer una sincronización completa o parcial.

Middleware de Validación

Para proteger tus rutas con el middleware de validación de permisos, utiliza capability.access en tus definiciones de rutas:

Route::middleware(['capability.access'])->group(function () {
    // Rutas protegidas
});

Asignar Roles

Para poder asignar roles a una entidad, es importante generar una relación polimórfica personalizada para relacionar el puente de comunicación entre la entidad (modelo) a capability_roles.

Usar el modelo que funcionará como puente de comunicación en una relación polimórfica de muchos a muchos:

use Lechuganegra\AccessManager\Models\RelationEntityRole;

Agregar la función de relación através del puente de conexión:

public function roles()
{
    return $this->morphMany(RelationEntityRole::class, 'entity', 'entity_module', 'entity_id');
}

Dirígete al archivo AppServiceProvider.php, y en tu boot de arranque, agregar la entidad que deseas vincular a la relación con roles, invocar la librería eloquent de relación:

use Illuminate\Database\Eloquent\Relations\Relation;

Agregar las entidades que desees, separado por ,:

Relation::morphMap([
    'user' => \App\Models\User::class,
]);

lechuganegra / accessmanager

Maintainers

Package info

Statistics

Security