Download the PHP package fuelviews/laravel-cloudflare-cache without Composer

Laravel Cloudflare Cache

A powerful and intuitive Laravel package for managing Cloudflare cache purging directly from your Laravel application. Streamline your cache management workflow with comprehensive commands, validation, and seamless integration.

📋 Requirements

• PHP 8.3+
• Laravel 10.x, 11.x, or 12.x
• Cloudflare account with API access

🚀 Installation

Install the package via Composer:

Quick Setup

Run the install command for guided setup:

This will:

• Publish the configuration file
• Guide you through credential setup
• Validate your configuration
• Provide helpful next steps

Manual Setup

Alternatively, you can manually publish the configuration:

⚙️ Configuration

Environment Variables

Add your Cloudflare credentials to your .env file:

Getting Your Cloudflare Credentials

1. API Key: Create an API token at Cloudflare API Tokens

   • Use the "Custom token" option
   • Required permissions: Zone:Zone:Read, Zone:Cache Purge:Edit
   • Zone Resources: Include specific zones or all zones
2. Zone ID: Find your Zone ID in your Cloudflare dashboard
   • Go to your domain overview
   • Find "Zone ID" in the right sidebar
   • It's a 32-character hexadecimal string

Configuration File

The published configuration file config/cloudflare-cache.php:

🎯 Basic Usage

Using the Facade

Using Dependency Injection

Environment-Aware Functionality

The package includes smart environment detection:

The ive() method returns true when:

• Running unit tests
• Debug mode is enabled (CLOUDFLARE_CACHE_DEBUG=true)
• Application is in production environment and credentials are configured

🛠️ Artisan Commands

Cache Clear Command

Purge all Cloudflare cache:

Success Output:

Error Output:

Validate Configuration

Check your configuration for issues:

Successful validation:

With errors:

Check Status

Test your API connection and configuration:

Successful status check:

With configuration issues:

🎛️ Advanced Usage

Integration with Events

Clear cache automatically when content changes:

Using in Queue Jobs

For better performance, queue cache purging operations:

Custom Service Provider

Publish and customize the service provider:

This publishes CloudflareCacheServiceProvider to your app/Providers directory for customization.

Middleware Integration

Create middleware to automatically purge cache:

🛡️ Exception Handling

The package provides comprehensive error handling:

🧪 Testing

Running Package Tests

Testing in Your Application

The package automatically handles testing environments:

Feature Testing

🐛 Troubleshooting

Common Issues

❌ "API Key not configured"

• Ensure CLOUDFLARE_CACHE_API_KEY is set in your .env file
• Run php artisan config:clear after updating environment variables
• Verify the API key has proper permissions

❌ "Zone ID format appears invalid"

• Zone IDs should be exactly 32 characters (hexadecimal)
• Check your Cloudflare dashboard for the correct Zone ID
• Ensure no extra spaces or characters

❌ "Request error: Invalid API Token"

• Verify your API token has the required permissions:
  • Zone:Zone:Read
  • Zone:Cache Purge:Edit
• Check that the token hasn't expired
• Ensure the token is active in your Cloudflare dashboard

❌ "Request error: Zone not found"

• Verify the Zone ID matches your domain
• Ensure the API token has access to the specified zone
• Check that the zone is active in Cloudflare

Debug Mode

Enable debug mode for detailed information:

With debug mode enabled:

• Cache purging works in all environments
• Additional logging information is available
• The ive() method always returns true

Validation Commands

Use built-in validation to diagnose issues:

Logging

Check Laravel logs for detailed error information:

📚 API Reference

CloudflareCacheInterface

purgeEverything(): bool|string

Purges all cache from Cloudflare for the configured zone.

Returns:

• string: Operation ID on success
• false: On failure (when API returns success: false)

Throws:

• CloudflareCacheRequestException: When API request fails

ive(): bool

Determines if cache purging should be performed based on environment and configuration.

Returns:

• true: When cache purging should be performed
• false: When cache purging should be skipped

Available Commands

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

Development Setup

📄 Changelog

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

🔐 Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

👨‍💻 Credits

• Joshua Mitchener
• Sweatybreeze
• Fuelviews
• Yediyuz
• Mertasan
• All Contributors

📜 License

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