# elgentos/magento2-clientside-cache
> Elgentos Clientside Cache
`composer require elgentos/magento2-clientside-cache`
Canonical URL: https://packagento.com/elgentos/magento2-clientside-cache
## At a glance
- **Vendor**: elgentos (https://packagento.com/elgentos.md)
- **Latest version**: 1.2.0 — released 2023-10-02
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers
## Installation
Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.
1. **Sign in or create an account** at https://packagento.com/customer/account/.
2. **Add the package to your account.** Open https://packagento.com/elgentos/magento2-clientside-cache and complete the free checkout. A licence is minted automatically.
3. **Create or pick a project, then activate the licence on it.**
- Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
- Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.
4. **Add the project credentials to your Magento codebase.**
Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:
```json
{
"http-basic": {
"packagento.com": {
"username": "ppk_live_...",
"password": "psk_live_..."
}
}
}
```
Add the Packagento Composer repository to `composer.json`:
```json
{
"repositories": [
{ "type": "composer", "url": "https://packagento.com" }
]
}
```
5. **Install and apply.**
```bash
composer require elgentos/magento2-clientside-cache:*
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush
```
## What it does
Elgentos Clientside Cache
## README
Magento already had support for ESI blocks, this will add an easy way to replace page heavy or slow blocks and
load them asynchronous without much hassle.
### Installation
```bash
composer require elgentos/magento2-clientside-cache
bin/magento setup:upgrade
```
### Usage
The easiest way is to add the ``
around the original block, and use the correct alias `as=""` so the original block knows how which `getChildHtml` to fetch.
`layout/LAYOUT_HANDLE.xml`
```xml
```
#### Limit handles
You can limit the handles within the Async wrapper. This increases the possibility to re-use requests.
An example would be menu's which are the same on every page.
`layout/default.xml`
```xml
- default
```
### Features
- Fetch content async
- Group similar requests for handles into on one single request
- Evaluate Javascript
### Javascript
If you want to make sure that your global functions or objects are available you need to make sure to assign them to global scope.
Some examples;
```html
```
### Custom integration
It's also possible to do custom integration too.
Use `clientsideCacheAsync` which will return a Promise and will with a object for all blocks you requested.
```javascript
clientsideCacheAsync(['block_name', 'other_block'], ['default', 'catalog_category_view']).then(results => console.log(results))
// {block_name: "", "other_block": ""}
clientsideCacheAsync(['another_block'], ['default', 'catalog_category_view']).then(results => console.log(results))
// {another_block: ""}
```
### Special thanks
The module was created during the Hackthon before the [Mage Unconference in Cologne](https://www.mageunconference.org/).
Thanks to the team for organising another great event and for the Hackathon.
### Author
- [Jeroen Boersma](https://github.com/JeroenBoersma)
## Recent Versions
| Version | Released |
|---|---|
| 1.2.0 | 2023-10-02 |
| 1.1.0 | 2023-10-02 |
| 1.0.0 | 2023-10-01 |
## Dependencies
### Require
| Package | Constraint |
|---|---|
| magento/framework | * |
| magento/module-page-cache | 100.4.* |
## Quality
Latest release (1.2.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.
### Compatibility
Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |
### Code Quality
Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.
#### Static Analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 11 | 4 errors, 7 warnings (ruleset: Magento2) — 6 auto-fixable with phpcbf |
| PHPMD | Pass | 0 | |
| Cpd | Pass | 0 | |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |
#### PHPStan
Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |
### Tests
Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.
#### Unit Tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |
#### Integration Tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |
### Security
Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.
| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 | |
| Malware scan | Pass | 0 | |
## Licence and pricing
Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.
Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.
## Install via Claude Code or any MCP client
The Packagento MCP server can run the licence + project + Composer steps above in one tool call:
```
purchase_and_install_packages(
composer_names=["elgentos/magento2-clientside-cache"],
project_id="proj_xxx"
)
```
This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.
## Vendor
elgentos is a Magento 2 vendor on Packagento. See https://packagento.com/elgentos.md for their full catalogue.