beat/paquete-opciones-beat

Paquete de opciones de BEAT

v1.1.0 2024-05-09 10:23 UTC

This package is auto-updated.

Last update: 2024-05-09 08:24:20 UTC


README

La idea es que este paquete pueda manejar de forma muy simple el almacenamiento de opciones de una aplicación. Un buen ejemplo de uso sería reemplazar constantes en el archivo .env, cómo configuraciones de correo o la dirección fiscal de una empresa, por lo que ofrece este paquete y así hacer estas configuraciones dinámicas sin tener que estar tocando archivos delicados.

¿Cómo se gestionan las opciones?

Muy sencillo, a través del servicio OpcionesService.php puedes obtener (método get o getTyped) y modificar (método set) las opciones definidas en el archivo de configuración beat_opciones.php dentro de la clave opciones. Este servicio almacena las opciones en base de datos en la tabla opciones, la cual sólo tiene dos campos, la clave y el valor de la opción. Ambos son de tipo string. Una vez el servicio crea o modifica la opción, ésta es guardada también en caché para así evitar llamadas repetitivas a la base de datos. El paquete ofrece dos rutas ya definidas con las que poder gestionar las opciones sin tener que añadir más código a tu proyecto:

  • GET => /opciones: recibe un array con las claves de las opciones a listar. Devuelve la siguiente estructura:
    
    

[

[clave_opcion1 => valor],
[clave_opcion2 => valor],

]

- `PUT => /opciones`: recibe un array cómo el del bloque de código anterior. Modificará cada opción que se le pase con el valor dado. Devuelve lo mismo que el anterior endpoint.

Ver [guía de configuración](./docs/configuration.md#opciones) para saber cómo añadir opciones.

## Requisitos



- PHP (7.4, 8.0, 8.1 o 8.2)
- Laravel 8.x

## Guía de usuario

- [Instalación](/docs/installation.md)
- [Configuración](/docs/configuration.md)