> For the complete documentation index, see [llms.txt](https://quantumphp.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://quantumphp.gitbook.io/docs/packages/resourcecache/usage.md).

# Usage

## Cache a rendered page

The package fits best around rendered HTML pages.

```php
use Quantum\Renderer\Factories\RendererFactory;
use Quantum\ResourceCache\ViewCache;

$cache = new ViewCache();
$cache->setup();

$key = request()->getPath();

if ($response = $cache->getCachedResponse($key)) {
    return $response;
}

$html = RendererFactory::get()->render('posts/index', [
    'posts' => $posts,
]);

$cache->set($key, $html);

return response()->html($html);
```

Use a key that matches the page variant you want to cache.

Because the package already scopes files by session ID, a route path is often enough for user-specific pages. Add query parameters, locale, or other response-shaping inputs when those change the rendered HTML.

## Change TTL for one cache instance

```php
$cache = new ViewCache();
$cache->setup();
$cache->setTtl(900);
```

Use this when one code path needs a different lifetime than the configured default.

The new TTL only affects this `ViewCache` instance.

## Toggle caching dynamically

```php
$cache = new ViewCache();
$cache->setup();
$cache->enableCaching(app()->isProduction());
```

This changes whether `getCachedResponse()` serves cached output for that instance.

Direct writes through `set()` remain available, so you can prebuild cache entries before turning reads on.

## Enable HTML minification

```php
$cache->setup();
$cache->enableMinification(true);
$cache->set($key, $html);
```

Use this when you want smaller cached HTML files.

Make sure the `voku/helper` HTML minifier dependency is available before enabling it.

## Remove a cached entry

```php
$cache->delete('/posts');
```

Use this after content updates when you know the old rendered page is stale.

Deletion targets the current session's cache file for that key, so the same logical page may still have separate entries for other visitor sessions.

## Common pitfalls

### Include all meaningful page variants in your key

The package uses the key string you provide.

If `/posts?page=2` should be cached separately from `/posts?page=1`, build that into the key yourself.

### Know when module context changes the storage path

If the current request has a module, files are stored under that module's cache directory.

That means the same key can resolve to different cache files depending on the active module.

### Expect lazy cleanup during cache access

Expired files are removed when the package checks them.

That keeps the package simple in normal request flow. If you want scheduled cleanup for old cache directories, add it at the application or infrastructure layer.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://quantumphp.gitbook.io/docs/packages/resourcecache/usage.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.