getpop/cache-control

Add HTTP caching to the response

0.8.8 2021-09-27 06:45 UTC

This package is auto-updated.

Last update: 2021-10-17 06:24:18 UTC


README

Add HTTP caching to the response

Install

Via Composer

composer require getpop/cache-control

Development

The source code is hosted on the PoP monorepo, under Engine/packages/cache-control.

Usage

Initialize the component:

\PoP\Root\AppLoader::addComponentClassesToInitialize([
    \PoP\CacheControl\Component::class,
]);

How it works

It adds a mandatory directive <cacheControl> to all fields, which has a max-age value set for each field.

The response will send a Cache-Control header with the lowest max-age from all the requested fields, or no-store if any field has max-age: 0.

Examples

Note:
Click on the following links below, and inspect the response headers using Chrome or Firefox's developer tools' Network tab.

Operators have a max-age of 1 year:

/?query=
  echo(Hello world!)

[View query results]

By default, fields have a max-age of 1 hour:

/?query=
  echo(Hello world!)|
  posts.
    title

[View query results]

Composed fields are also taken into account when computing the lowest max-age:

/?query=
  echo(posts())

[View query results]

"time" field is not to be cached (max-age: 0):

/?query=
  time

[View query results]

Ways to not cache a response:

a. Add field "time" to the query:

/?query=
  time|
  echo(Hello world!)|
  posts.
    title

[View query results]

b. Override the default maxAge configuration for a field, by adding argument maxAge: 0 to directive <cacheControl>:

/?query=
  echo(Hello world!)|
  posts.
    title<cacheControl(maxAge:0)>

[View query results]

PHP versions

Requirements:

  • PHP 8.0+ for development
  • PHP 7.1+ for production

Supported PHP features

Check the list of Supported PHP features in leoloso/PoP

Preview downgrade to PHP 7.1

Via Rector (dry-run mode):

composer preview-code-downgrade

Standards

PSR-1, PSR-4 and PSR-12.

To check the coding standards via PHP CodeSniffer, run:

composer check-style

To automatically fix issues, run:

composer fix-style

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

To execute PHPUnit, run:

composer test

Static Analysis

To execute PHPStan, run:

composer analyse

Report issues

To report a bug or request a new feature please do it on the PoP monorepo issue tracker.

Contributing

We welcome contributions for this package on the PoP monorepo (where the source code for this package is hosted).

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email leo@getpop.org instead of using the issue tracker.

Credits

License

GNU General Public License v2 (or later). Please see License File for more information.