Download the PHP package acpl/flarum-lscache without Composer
On this page you can find all versions of the php package acpl/flarum-lscache. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package flarum-lscache
LiteSpeed Cache for Flarum
A Flarum extension. Integrates LSCache with your forum.
Requires a LiteSpeed Web Server or OpenLiteSpeed.
Installation
Install with composer:
Upon initial activation, the extension will add its configurations to the .htaccess file.
It's recommended to back up your .htaccess file before installing the extension.
Updating
Cache Management
This extension smartly manages the cache by purging it only where needed. For instance, when a new post is added in a discussion, the cache for that specific discussion, its tags, and the homepage are purged.
When you clear the Flarum cache, the LSCache is also cleared automatically unless you disable this feature in the settings.
You can clear the LSCache without clearing the Flarum cache via the admin panel. This option is available under the standard Flarum cache clearing option. There is also the php flarum lscache:clear command. The command supports the --path argument. For example, php flarum lscache:clear --path=/tags --path=/d/1-test. You can use this if you only want to purge specific paths instead of the entire cache.
For Developers
How the Extension Tags Paths
First, it's useful to understand how the extension adds LSCache tags to forum paths.
The extension uses route names. For example, if you registered routes for a resource in your extension named examples:
The extension will automatically add the following tags to the response:
- For paths with the
.indexsuffix (e.g.,examples.index):- A tag corresponding to the main resource name is added (e.g.,
examples)
- A tag corresponding to the main resource name is added (e.g.,
- For other paths:
- A tag with the full path name is added (e.g.,
examples.overview)
- A tag with the full path name is added (e.g.,
- If the request contains parameters:
- For the
idparameter: a tag{resource}_{id}is added (e.g.,example_1) - For the
slugparameter: a tag{resource}_{slug}is added (e.g.,example_example-slug)
- For the
[!TIP] To see the cache tags added for a given request, check the value of the
X-LiteSpeed-Tagheader in the Network tab of DevTools.
Purging Cache
By default, the extension purges the cache for a resource with a given ID if it detects successful requests to paths with the suffixes .create, .update, .delete.
To disable this behavior and add your own event handling, add your resource to the $resourcesSupportedByEvent array:
Then you can create an event listener:
[!TIP] It is recommended to purge cache tags instead of paths, as they also apply to different versions of the address, e.g., with query strings.
It's also possible to create an event subscriber if you want to group multiple listeners in one class:
