tv2regionerne/statamic-cache

There is no license information available for the latest version (dev-main) of this package.

dev-main 2024-04-10 06:44 UTC

Requires

• php: ^8.2
• pixelfear/composer-dist-plugin: ^0.1.5
• statamic/cms: ^4.0 || ^5.0

Requires (Dev)

• laravel/pint: ^1.13
• mockery/mockery: ^1.3.1
• nunomaduro/collision: ^6.0 || ^7.0
• orchestra/testbench: ^7.0 || ^8.0
• pestphp/pest: ^2.24
• phpunit/phpunit: ^9.0 || ^10.0

Unknown License

README

Statamic Autocache is an addon that automatically caches the content of any partials for a faster response time and selective invalidation

How to Install

Run the following command from your project root:

composer require tv2regionerne/statamic-cache

Then run the migrations:

php artisan migrate

You can also optionally publish the config:

php artisan vendor:publish --tag=statamic-cache-config

How to Use

The addon should work automatically in most cases. It adds hooks to partial, nav and collection tags, as well as augmentation of entries and globals to determine what content is included in what partials. This data is then added to a database store that is used to determine what cached data should be invalidated at what times.

The default cache is used, or you can specify a cache store called statamic_autocache if you want to have more control over when it is cleared.

Middleware

The autocache middleware will automatically be added to your web middleware stack. If you want to include it to other stacks simply add:

\Tv2regionerne\StatamicCache\Http\Middleware\Autocache::class

Store

The addon comes with a Facade for interacting with the Store: \Tv2regionerne\StatamicCache\Facades\Store

If you want to add extra data to the store you can do so using in your AppServiceProvider, eg:

MyTag::hook('init', function () {
	Store::mergeTags(['my_tag:id']);
});

Make sure you also invalidate the tag in a listener:

Store::invalidateContent(['my_tag:id']);