library laravel-httpcache

barryvdh/laravel-httpcache

HttpCache for Laravel 5

HttpCache for Laravel

, _(*1)

Laravel can use HttpKernelInterface Middlewares, so also HttpCache. This package provides a simple ServiceProvider to get you started with HttpCache., _(*2)

First, require this package with composer, _(*3)

composer require barryvdh/laravel-httpcache

After updating, add the ServiceProvider to the array of providers in app/config/app.php, _(*4)

'Barryvdh\HttpCache\ServiceProvider',

You can now add the Middleware to your Kernel:, _(*5)

'Barryvdh\HttpCache\Middleware\CacheRequests',

Caching is now enabled, for public responses. Just set the Ttl or MaxSharedAge, _(*6)

Route::get('my-page', function(){
   return Response::make('Hello!')->setTtl(60); // Cache 1 minute
});

You can use the provided SetTtl middleware in your Kernel to simplify this:, _(*7)

protected $routeMiddleware = [
    // ...
    'ttl' => \Barryvdh\HttpCache\Middleware\SetTtl::class,
];

Route::get('my-page', function(){
   return 'Hello' 
})->middleware('ttl:60'); // Cache 1 minute

Publish the config to change some options (cache dir, default ttl, etc) or enable ESI., _(*8)

$ php artisan vendor:publish --provider="Barryvdh\HttpCache\ServiceProvider"

Direct approach, without ServiceProvider

Note: This is still in beta, test with caution. It should be faster, but less flexible because it starts earlier., _(*9)

You can also wrap the Kernel in the HttpCache, in your public/index.php. Replace the 'Run The Application' part like this:, _(*10)

$kernel = $app->make(Illuminate\Contracts\Http\Kernel::class);

$kernel = \Barryvdh\HttpCache\CacheKernel::wrap($kernel);

$response = $kernel->handle(
    $request = Illuminate\Http\Request::capture()
);

$response->send();

$kernel->terminate($request, $response);

ESI

Enable ESI in your config file and add the Esi Middleware to your Kernel:, _(*11)

'Barryvdh\HttpCache\Middleware\ParseEsi',

You can now define ESI includes in your layouts., _(*12)

<esi:include src="<?= url('partial/page') ?>"/>

This will render partial/page, with it's own TTL. The rest of the page will remain cached (using it's own TTL), _(*13)

Purging/flushing the cache

You can purge a single url or just delete the entire cache directory:, _(*14)

App::make('http_cache.store')->purge($url);
\File::cleanDirectory(app('http_cache.cache_dir'));

Or use the Artisan httpcache:clear command, _(*15)

$ php artisan httpcache:clear

More information

For more information, read the Docs on Symfony HttpCache, _(*16)