yediyuz/laravel-cloudflare-cache

laravel-cloudflare-cache

v1.2.0 2024-03-14 21:58 UTC

Requires

• php: ^8.1
• guzzlehttp/guzzle: ^7.8
• illuminate/contracts: ^10.10|^11.0
• illuminate/routing: ^10.10|^11.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^2.0
• laravel/framework: ^10.10|^11.0
• nunomaduro/collision: ^7.0|^8.0
• orchestra/testbench: ^8.18|^9.0
• pestphp/pest: ^2.28
• pestphp/pest-plugin-laravel: ^2.2
• phpstan/phpstan: ^1.10
• phpunit/phpcov: ^9.0.2
• spatie/laravel-ray: ^1.32
• yediyuz/dev-tools: 1.x-dev

MIT

• Emre Dipi
• Mert Aşan

• cache
• laravel
• cloudflare
• yediyuz
• laravel-cloudflare-cache
• cloudflare-cache

README

Laravel Cloudflare Cache

You can serve millions of requests with this package. This package provides cacheable routes for Cloudflare. Thanks to Cloudflare, your static pages are served efficiently, reducing the load on your servers if they are cached for the TTL (Time to Live) duration. You can purge the cache whenever you need with this package.

Installation

You can install the package via composer:

composer require yediyuz/laravel-cloudflare-cache

You can publish the config file with:

php artisan vendor:publish --tag="cloudflare-cache-config"

Add environment variables to .env file

CLOUDFLARE_CACHE_EMAIL=[e-mail] #Cloudflare account email address
CLOUDFLARE_CACHE_KEY=XXXXXXX #Cloudflare API_KEY
CLOUDFLARE_CACHE_IDENTIFIER=XXXXXXX #ZONE_ID
CLOUDFLARE_DEFAULT_CACHE_TTL=600 #10 minutes
CLOUDFLARE_CACHE_DEBUG=false

Add Rule on Cloudflare

To active caching on static pages, you need to add page rule OR cache rule on Cloudflare.

For page rule:

• If the URL matches: www.example.com/*
• Setting: Cache Level
• Value: Cache Everything

For the cache rule:

• Field: hostname
• Operator: equals
• Value: example.com
• Then: Eligible for cache

https://developers.cloudflare.com/cache/how-to/cache-rules/create-dashboard/

Usage

Define routes to cache

You can use cache groups for your static contents.

Route::cache()->group(function () {
    Route::get('/content', function () {
        return 'content';
    });
});

You can use cache tags, so you can clear your caches easily. Specify custom ttl for expire time in seconds. When you do not pass ttl, it will use default ttl given in the config.

Route::cache(tags: ['tag1', 'tag2'], ttl: 600)->group(function () {
    Route::get('/content_with_tags', function () {
        return 'content';
    });
});

Route::cache(tags: ['staticPages'])->group(function () {
    //
});

Warning

Be careful caching your routes! Do not cache your dynamic pages such as admin panel or form based pages!

Clear Cache

Purges everything

https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/

CloudflareCache::purgeEverything()

Purges by urls

https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/

CloudflareCache::purgeByUrls([
    'https://example.com/hello',
])

Purges by prefixes (Enterprise only)

https://developers.cloudflare.com/cache/how-to/purge-cache/purge_by_prefix/

CloudflareCache::purgeByPrefixes([
    'www.example.com/foo',
])

Purges by tags (Enterprise only)

https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/

CloudflareCache::purgeByTags([
    'staticPages',
])

Purges by hostname (Enterprise only)

https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-hostname/

CloudflareCache::purgeByHosts([
    'www.example.com',
    'images.example.com',
])

Post update example to clear cache

<?php

namespace App\Http\Controllers;

use App\Http\Requests\UpdatePostRequest;
use App\Models\Post;
use Yediyuz\CloudflareCache\Facades\CloudflareCache;

class PostController extends Controller
{
    public function update(Post $post, UpdatePostRequest $request)
    {
        $post->update($request->validated());

        CloudflareCache::purgeByUrls([
            route('post.show', $post->id)
        ]);

        return back()->with('message', 'Post updated and url cache purged');
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you've found a bug regarding security please mail [e-mail] instead of using the issue tracker.

Credits

• Emre Dipi
• Mert Aşan
• All Contributors

License

The MIT License (MIT). Please see License File for more information.