FOSHttpCache

This is the documentation for the FOSHttpCache library.

This library integrates your PHP applications with HTTP caching proxies such as Varnish, NGINX or the Symfony HttpCache class. Use this library to send invalidation requests from your application to the caching proxy and to test your caching and invalidation setup.

If you use the Symfony full stack framework, have a look at the FOSHttpCacheBundle. The bundle provides the Invalidator as a service, support for the built-in cache kernel of Symfony and a number of Symfony-specific features to help with caching and caching proxies.

Contents:

• Getting started
  • Installation
  • Configuration
  • Overview
• An Introduction to Cache Invalidation
  • HTTP Caching Terminology
  • What is Cache Invalidation?
  • Invalidation Methods
• Caching Proxy Configuration
  • Varnish Configuration
  • NGINX Configuration
  • Symfony HttpCache Configuration
• Caching Proxy Clients
  • Setup
  • Using the Clients
  • Custom Guzzle Client
• The Cache Invalidator
  • Setup
  • Invalidating Paths and URLs
  • Refreshing Paths and URLs
  • Invalidating With a Regular Expression
  • Flushing
  • Error handling
• Extra Invalidation Handlers
  • Tag Handler
• Cache on User Context
  • Overview
  • Proxy Client Configuration
  • User Context Hash from Your Application
  • The Original Request
  • Alternative for Paywalls: Authorization Request
• Testing Your Application
  • Setting Constants
  • Overriding Getters
• Contributing
  • Testing the Library
  • Building the Documentation