https://github.com/barryvdh/laravel-httpcache
Laravel HTTP Cache
https://github.com/barryvdh/laravel-httpcache
Last synced: 24 days ago
JSON representation
Laravel HTTP Cache
- Host: GitHub
- URL: https://github.com/barryvdh/laravel-httpcache
- Owner: barryvdh
- Created: 2013-12-18T12:10:08.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-03-09T19:23:23.000Z (about 1 year ago)
- Last Synced: 2024-10-29T20:56:03.473Z (7 months ago)
- Language: PHP
- Size: 56.6 KB
- Stars: 484
- Watchers: 18
- Forks: 41
- Open Issues: 23
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## HttpCache for Laravel
[](https://github.com/barryvdh/laravel-httpcache/actions)
[](http://choosealicense.com/licenses/mit/)
[](https://packagist.org/packages/barryvdh/laravel-httpcache)
[](https://packagist.org/packages/barryvdh/laravel-httpcache)
[](https://fruitcake.nl/)
Laravel can use [HttpKernelInterface Middlewares](http://stackphp.com/middlewares/), so also [HttpCache](http://symfony.com/doc/current/book/http_cache.html).
This package provides a simple ServiceProvider to get you started with HttpCache.
First, require this package with composer
```
composer require barryvdh/laravel-httpcache
```
After updating, add the ServiceProvider to the array of providers in app/config/app.php
```
'Barryvdh\HttpCache\ServiceProvider',
```
You can now add the Middleware to your Kernel:
```
'Barryvdh\HttpCache\Middleware\CacheRequests',
```
Caching is now enabled, for public responses. Just set the Ttl or MaxSharedAge
```php
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:
```php
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.
$ 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.
You can also wrap the Kernel in the HttpCache, in your public/index.php. Replace the 'Run The Application' part like this:
```
$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:
'Barryvdh\HttpCache\Middleware\ParseEsi',
You can now define ESI includes in your layouts.
This will render partial/page, with it's own TTL. The rest of the page will remain cached (using it's own TTL)
### Purging/flushing the cache
You can purge a single url or just delete the entire cache directory:
```php
App::make('http_cache.store')->purge($url);
\File::cleanDirectory(app('http_cache.cache_dir'));
```
Or use the Artisan `httpcache:clear` command
$ php artisan httpcache:clear
### More information
For more information, read the [Docs on Symfony HttpCache](http://symfony.com/doc/current/book/http_cache.html#symfony2-reverse-proxy)