getpop/cache-control

Add HTTP caching to the response

Maintainers

Details

github.com/getpop/cache-control

Homepage

Source

Installs: 12 705

Dependents: 12

Suggesters: 8

Security: 0

Stars: 1

Watchers: 2

Forks: 0

9.0.0 2024-12-16 10:11 UTC

Requires

Requires (Dev)

Conflicts

GPL-2.0-or-later 13b8ca8bcdbef9ba5d24630756250762b92db368

phpcache-controlgraphqlGatoGatoGraphQL

This package is auto-updated.

Last update: 2024-12-20 06:55:40 UTC

README

Add HTTP caching to the response

Install

Via Composer

composer require getpop/cache-control

Development

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

Usage

Initialize the component:

\PoP\Root\App::stockAndInitializeModuleClasses([([
    \PoP\CacheControl\Module::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.

PHP versions

Requirements:

  • PHP 8.1+ for development
  • PHP 7.4+ for production

Supported PHP features

Check the list of Supported PHP features in GatoGraphQL/GatoGraphQL

Preview downgrade to PHP 7.4

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 GatoGraphQL monorepo issue tracker.

Contributing

We welcome contributions for this package on the GatoGraphQL 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.