mutation/filecache

Cache templates to html files

4.0.0 2024-09-04 14:42 UTC

Requires

• php: ^8.0.2
• craftcms/cms: ^4.0.0|^5.0.0

Requires (Dev)

• craftcms/rector: dev-main

MIT

• Mutation Digitale

README

The html file cache is created automatically when you visit a page and then served when the page is visited after. The cache automatically is cleared when an element is saved, modified or deleted.

Installation

Install the plugin via the Plugin Store or by command line:

composer require mutation/filecache
php craft install/plugin filecache

Configuration

Add a file named filecache.php to the config folder:

<?php

return [
	'*' => [
		'excludedEntrySections' => [],
		'excludedEntryTypes' => [],
		'excludedSites' => [],
		'cacheFolderPath' => 'filecache'
	]
];

Exclude entries from cache by section excludedEntrySections, type excludedEntryTypes or site excludedSites by adding the section/type handles to their respective arrays.

How to use

You can visit this url to clear the cache manually: /admin/utilities/clear-caches.

You can also use these 2 console commands (@web alias must be set to an absolute url):

php craft clear-caches/file-caches

Dynamic content

Use this template code to inject the csrf token in html:

{{ craft.filecache.injectCsrfInput() }}

Use this template code to inject the csrf token as global Javascript variables:

{{ craft.filecache.injectJsCsrfToken() }}