buzzingpixel/static-cache-middleware

1.0.1 2021-10-29 18:43 UTC

Requires

• php: ^8.0
• psr/http-factory: ^1.0
• psr/http-server-middleware: ^1.0

Requires (Dev)

• codedungeon/phpunit-result-printer: ^0.31.0
• doctrine/coding-standard: ^9
• friendsofphp/php-cs-fixer: ^2.18
• league/flysystem: ^1.0.0
• php-di/php-di: ^6.3
• phpstan/phpstan: ^0.12.69
• phpstan/phpstan-deprecation-rules: ^0.12.6
• phpstan/phpstan-strict-rules: ^0.12.9
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.5
• symfony/var-dumper: ^5.3
• vimeo/psalm: ^4.4

Apache-2.0

• TJ Draper

README

Very often, entire page responses can be cached the first time it is loaded and that cache can subsequently be served instead of building the page from the various PHP and Database components on the next request. While this sort of cache can be accomplished in a variety of ways, this package does it through a PSR middleware. There are currently also two drivers available: Redis and File. You can also implement the CacheApiContract to provide your own.

Here's how to use it:

1. In your project, run composer require buzzingpixel/static-cache-middleware
2. Configure your DI to serve the StaticCacheMiddleware with the two constructor parameters of whether to enable the static cache at all (this is nice for passing in an env variable), and the driver you wish to use. See the examples.
3. When crafting a response, set EnableStaticCache to string of 'true'.

$response = $this->responseFactory->createResponse()
    ->withHeader('EnableStaticCache', 'true');