Prepare Beta Version
This commit is contained in:
@ -1,12 +1,12 @@
|
||||
# Koneko ERP - Cache Helper Guide
|
||||
|
||||
> ✨ Esta guía detalla el uso correcto del sistema de cache en Koneko ERP, basado completamente en el helper `cache_manager()`, sin necesidad de interactuar con las clases internas como `KonekoCacheManager` o `LaravelCacheManager`.
|
||||
> ✨ Esta guía detalla el uso correcto del sistema de cache en Koneko ERP, basado completamente en el helper `cache_m()`, sin necesidad de interactuar con las clases internas como `KonekoCacheManager` o `LaravelCacheManager`.
|
||||
|
||||
---
|
||||
|
||||
## 🔎 Filosofía
|
||||
|
||||
* Toda interacción de componentes con el sistema de cache debe realizarse exclusivamente mediante el helper `cache_manager()`.
|
||||
* Toda interacción de componentes con el sistema de cache debe realizarse exclusivamente mediante el helper `cache_m()`.
|
||||
* Las clases internas son consideradas **@internal**, y no deben ser accedidas directamente por desarrolladores de componentes.
|
||||
* El sistema permite configuración jerárquica basada en namespace del componente, grupo lógico de datos y claves individuales.
|
||||
|
||||
@ -15,15 +15,15 @@
|
||||
## 🔍 Sintaxis del Helper
|
||||
|
||||
```php
|
||||
cache_manager(string $component = 'admin', string $group = 'cache')
|
||||
cache_m(string $component = 'admin', string $group = 'cache')
|
||||
```
|
||||
|
||||
Retorna una instancia segura del gestor para el componente y grupo indicados. Ejemplos:
|
||||
|
||||
```php
|
||||
cache_manager('admin', 'avatar')->enabled();
|
||||
cache_manager('website', 'menu')->ttl();
|
||||
cache_manager('website', 'html')->flush();
|
||||
cache_m('admin', 'avatar')->enabled();
|
||||
cache_m('website', 'menu')->ttl();
|
||||
cache_m('website', 'html')->flush();
|
||||
```
|
||||
|
||||
---
|
||||
@ -60,13 +60,13 @@ Esto permite granularidad sin perder coherencia global.
|
||||
### Validar TTL efectivo
|
||||
|
||||
```php
|
||||
$ttl = cache_manager('website', 'menu')->ttl();
|
||||
$ttl = cache_m('website', 'menu')->ttl();
|
||||
```
|
||||
|
||||
### Verificar si está habilitado
|
||||
|
||||
```php
|
||||
if (cache_manager('admin', 'avatar')->enabled()) {
|
||||
if (cache_m('admin', 'avatar')->enabled()) {
|
||||
// Proceder con cache
|
||||
}
|
||||
```
|
||||
@ -74,7 +74,7 @@ if (cache_manager('admin', 'avatar')->enabled()) {
|
||||
### Limpiar cache con soporte para etiquetas
|
||||
|
||||
```php
|
||||
cache_manager('website', 'html')->flush();
|
||||
cache_m('website', 'html')->flush();
|
||||
```
|
||||
|
||||
---
|
||||
@ -112,6 +112,6 @@ El comando mostrará información relevante para depuración sin exponer clases
|
||||
|
||||
## 🌟 Conclusión
|
||||
|
||||
Este sistema garantiza modularidad, extensibilidad y seguridad. El helper `cache_manager()` es la única puerta de entrada para desarrolladores y debe usarse exclusivamente para mantener la integridad del ecosistema.
|
||||
Este sistema garantiza modularidad, extensibilidad y seguridad. El helper `cache_m()` es la única puerta de entrada para desarrolladores y debe usarse exclusivamente para mantener la integridad del ecosistema.
|
||||
|
||||
> ✅ Si necesitas agregar un nuevo grupo de cache, simplemente define su configuración y comienza a usar el helper, sin necesidad de modificar clases o contratos.
|
||||
|
@ -9,7 +9,7 @@ Este documento define las reglas de exposición y acceso para los servicios téc
|
||||
| Clase Técnica | Expuesta al Usuario | Acceso Recomendado | Notas |
|
||||
| --------------------------------- | ------------------- | -------------------------- | ---------------------------------------------------------------- |
|
||||
| `KonekoSettingManager` | ❌ No | `settings()` helper | Configuración modular con soporte de namespaces. |
|
||||
| `KonekoCacheManager` | ❌ No | `cache_manager()` helper | Acceso al sistema de cache multi-driver y con TTL configurables. |
|
||||
| `KonekoCacheManager` | ❌ No | `cache_m()` helper | Acceso al sistema de cache multi-driver y con TTL configurables. |
|
||||
| `KonekoSystemLogger` | ❌ No | `log_system()` helper | Logger morfable con niveles y contexto extendido. |
|
||||
| `KonekoSecurityLogger` | ❌ No | `log_security()` helper | Eventos de seguridad con GeoIP y proxy detection. |
|
||||
| `KonekoUserInteractionLogger` | ❌ No | `log_interaction()` helper | Auditoría de componentes y acciones sensibles. |
|
||||
@ -28,7 +28,7 @@ Este documento define las reglas de exposición y acceso para los servicios téc
|
||||
## 💡 Buenas prácticas para desarrolladores
|
||||
|
||||
* Usa `settings()` para acceder o escribir configuraciones modulares.
|
||||
* Usa `cache_manager()` para obtener TTL, flush o debug por componente.
|
||||
* Usa `cache_m()` para obtener TTL, flush o debug por componente.
|
||||
* Usa `log_system()` para registrar eventos de sistema de forma morfable.
|
||||
* Usa `log_security()` para eventos como logins fallidos o IP sospechosas.
|
||||
* Usa `log_interaction()` para acciones en Livewire, eventos UI o tracking avanzado.
|
||||
@ -40,7 +40,7 @@ Este documento define las reglas de exposición y acceso para los servicios téc
|
||||
```php
|
||||
// Correcto
|
||||
settings()->in('website')->get('general.site_name');
|
||||
cache_manager('admin', 'menu')->ttl();
|
||||
cache_m('admin', 'menu')->ttl();
|
||||
log_system('info', 'Menú regenerado');
|
||||
```
|
||||
|
||||
|
@ -90,7 +90,7 @@ El evento registrado se almacena en la tabla `security_events`, con campos como:
|
||||
Si tienes habilitado el trait `HasGeolocation`, el sistema hace *GeoIP Lookup* por IP:
|
||||
|
||||
```php
|
||||
use Koneko\VuexyAdmin\Support\Traits\Helpers\HasGeolocation;
|
||||
use Koneko\VuexyAdmin\Support\Traits\Geolocation\HasGeolocation;
|
||||
```
|
||||
|
||||
---
|
||||
|
Reference in New Issue
Block a user