Getting started

Installation

The FOSHttpCache library is available on Packagist. You can install it using Composer:

$ composer require friendsofsymfony/http-cache:~1.0

Note

This library follows Semantic Versioning. Because constraint ~1.0 will only increment the minor and patch numbers, it will not introduce BC breaks.

Configuration

There are three things you need to do to get started:

  1. configure your caching proxy
  2. set up a client for your caching proxy
  3. set up the cache invalidator

Overview

This library mainly consists of:

  • low-level clients for communicating with caching proxies (Varnish and NGINX)
  • a cache invalidator that acts as an abstraction layer for the caching proxy clients
  • test classes that you can use for integration testing your application against a caching proxy.

Measures have been taken to minimize the performance impact of sending invalidation requests:

  • Requests are not sent immediately, but aggregated to be sent in parallel.
  • You can determine when the requests should be sent. For optimal performance, do so after the response has been sent to the client.