Caching

Main Cache Settings

Configure basic cache settings in config/inspirecms.php:

'cache' => [
    'languages' => [
        'key' => 'inspirecms.languages',
        'ttl' => 60 * 60 * 24, // 24 hours in seconds
    ],
    'navigation' => [
        'key' => 'inspirecms.navigation',
        'ttl' => 60 * 60 * 24,
    ],
    'content_routes' => [
        'key' => 'inspirecms.content_routes',
        'ttl' => 120 * 60 * 24, // 120 days in seconds
    ],
    'key_value' => [
        'ttl' => 60 * 60 * 24,
    ],
],

Laravel Cache Driver Configuration

InspireCMS uses Laravel's caching system. Configure the cache driver in config/cache.php:

'default' => env('CACHE_DRIVER', 'file'),

'stores' => [
    'file' => [
        'driver' => 'file',
        'path' => storage_path('framework/cache/data'),
    ],
    'redis' => [
        'driver' => 'redis',
        'connection' => 'cache',
        'lock_connection' => 'default',
    ],
    'memcached' => [
        'driver' => 'memcached',
        'persistent_id' => env('MEMCACHED_PERSISTENT_ID'),
        'sasl' => [
            env('MEMCACHED_USERNAME'),
            env('MEMCACHED_PASSWORD'),
        ],
        'options' => [
            // Memcached::OPT_CONNECT_TIMEOUT => 2000,
        ],
        'servers' => [
            [
                'host' => env('MEMCACHED_HOST', '127.0.0.1'),
                'port' => env('MEMCACHED_PORT', 11211),
                'weight' => 100,
            ],
        ],
    ],
],

Navigation Cache Configuration

// config/inspirecms.php
'cache' => [
    'navigation' => [
        'key' => 'inspirecms.navigation',
        'ttl' => 60 * 60 * 24, // 24 hours in seconds
    ],
],

Working with Navigation Cache

Example of cached navigation retrieval:

// This method internally uses caching
$navigation = inspirecms()->getNavigation('main', 'en');

Invalidating Navigation Cache

Clear the navigation cache manually:

// Clear all navigation cache
\SolutionForest\InspireCms\Facades\InspireCms::forgetCachedNavigation();

Route Cache Configuration

// config/inspirecms.php
'cache' => [
    'content_routes' => [
        'key' => 'inspirecms.content_routes',
        'ttl' => 120 * 60 * 24, // 120 days in seconds
    ],
],

Route Cache Commands

In addition to Laravel's route caching, clear InspireCMS route cache:

php artisan route:clear

or

php artisan inspirecms:clear-cache --routes

View Cache

Laravel's view cache for compiled templates:

# Cache all Blade templates
php artisan view:cache

# Clear view cache
php artisan view:clear

Fragment Caching

Cache specific parts of templates:

@php
$cacheKey = "content_block_{$content->id}_" . md5(json_encode($content_block_data));
$cacheTtl = 60 * 24; // 24 hours in minutes
@endphp

@cache($cacheKey, $cacheTtl)
    <div class="complex-content-block">
        <!-- Complex or slow-rendering content -->
        @foreach($content_block_data as $item)
            <div class="item">{{ $item->title }}</div>
        @endforeach
    </div>
@endcache

Model Cache

Cache model queries directly:

use Illuminate\Support\Facades\Cache;
use SolutionForest\InspireCms\InspireCmsConfig;

// Get all published blog posts, cached for 1 hour
$posts = Cache::remember('published_blog_posts', 3600, function () {
    return InspireCmsConfig::getContentModelClass()::query()
        ->whereHas('documentType' => fn ($q) => $q->where('slug', 'blog'))
        ->whereIsPublished()
        ->latest()
        ->get();
});

// Or via service
$posts = Cache::remember('published_blog_posts', 3600, function () {
    return inspirecms_content()->getUnderRealPath(
        path: 'home/blogs',
        isPublished: true,
        sorting: [
            '__latest_version_dt' => 'desc',
        ]
    );
});

Query Cache Considerations

• Cache appropriate queries (frequently accessed, rarely changing)
• Use specific cache keys based on query parameters
• Set appropriate TTL based on data volatility
• Clear cache when data changes

Media Cache Configuration

Configure cache headers for media assets:

// config/inspirecms.php
'media' => [
    'media_library' => [
        // other settings...
        'middlewares' => [
            'cache.headers:public;max_age=2628000;etag',
        ],
    ],
],

Asset Preprocessing

For frontend assets, use Laravel Mix or Vite with proper versioning:

// In your template
<link rel="stylesheet" href="{{ mix('css/app.css') }}">
<script src="{{ mix('js/app.js') }}" defer></script>

Cache Headers

InspireCMS sets proper cache headers for different content types:

// Example middleware implementation
public function handle($request, Closure $next)
{
    $response = $next($request);
    
    // For public, unchanging content
    if ($this->shouldCache($request)) {
        $response->header('Cache-Control', 'public, max-age=3600');
    } else {
        // For dynamic or user-specific content
        $response->header('Cache-Control', 'no-store, private');
    }
    
    return $response;
}

Custom Cache Middleware

Create custom cache middleware for specific sections:

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;

class CacheControl
{
    public function handle(Request $request, Closure $next)
    {
        $response = $next($request);
        
        if ($request->segment(1) === 'blog') {
            // Cache blog pages for 1 hour
            $response->header('Cache-Control', 'public, max-age=3600');
        } elseif ($request->segment(1) === 'products') {
            // Cache product pages for 15 minutes
            $response->header('Cache-Control', 'public, max-age=900');
        }
        
        return $response;
    }
}

Register in app/Http/Kernel.php:

protected $middlewareGroups = [
    'web' => [
        // ...
        \App\Http\Middleware\CacheControl::class,
    ],
];

Cache Warming Command

Create a command to pre-populate cache:

namespace App\Console\Commands;

use Illuminate\Console\Command;
use SolutionForest\InspireCms\Models\Contracts\Content;

class WarmCacheCommand extends Command
{
    protected $signature = 'inspirecms:warm-cache';
    protected $description = 'Warm the InspireCMS content cache';

    public function handle()
    {
        // Warm language
        $this->info('Warming language cache...')
        $langs = inspirecms()->getAllAvailableLanguages();

        // Warm main navigation
        $this->info('Warming navigation cache...');
        inspirecms()->getNavigation('main');
        
        // Warm homepage and main sections
        $this->info('Warming content cache...');
        $contentClass = InspireCmsConfig::getContentModelClass();
        
        // Get homepage
        $homepage = $contentClass::whereIsDefault()->first();
        if ($homepage) {
            $this->cacheContent($homepage);
        }
        
        // Cache main sections
        $mainSections = $contentClass::whereParentId($homepage->id ?? null)
            ->whereIsPublished()
            ->get();
            
        foreach ($mainSections as $section) {
            $this->cacheContent($section);
        }
        
        $this->info('Cache warming complete');
        
        return Command::SUCCESS;
    }
    
    protected function cacheContent(Content $content)
    {
        // Access properties to cache them
        $content->getTitle();
        $content->getUrl();
        $content->getSeo();
        
        // Process content properties
        foreach ($content->getPropertyGroups() as $group) {
            foreach ($group->getProperties() as $property) {
                $property->getValue();
            }
        }
        
        $this->line("Cached content: {$content->title}");
    }
}

Schedule cache warming:

// app/Console/Kernel.php
protected function schedule(Schedule $schedule)
{
    // Warm cache daily during off-peak hours
    $schedule->command('inspirecms:warm-cache')->dailyAt('3:00');
}

Cache Clear Commands

InspireCMS provides specific commands for clearing various caches:

# Clear all InspireCMS caches
php artisan inspirecms:clear-cache --all

# Clear specific caches
php artisan inspirecms:clear-cache --languages
php artisan inspirecms:clear-cache --routes
php artisan inspirecms:clear-cache --navigation

Automatic Cache Clearing

InspireCMS automatically clears relevant caches when:

• Content is created, updated or deleted
• Settings are changed
• Templates are modified
• Navigation is restructured

Cache Hit/Miss Tracking

Implement cache monitoring:

// Custom cache wrapper
public function remember($key, $ttl, $callback)
{
    $exists = Cache::has($key);
    
    $startTime = microtime(true);
    $value = Cache::remember($key, $ttl, $callback);
    $endTime = microtime(true);
    
    $duration = ($endTime - $startTime) * 1000; // in ms
    
    $status = $exists ? 'HIT' : 'MISS';
    Log::debug("Cache {$status}: {$key} ({$duration}ms)");
    
    return $value;
}

Cache Performance Dashboard

Consider implementing a cache monitoring dashboard:

• Cache hit rate
• Average cache retrieval time
• Cache storage usage
• Cache invalidation frequency