Overview
========

Installation
------------

This bundle is available on Packagist_. You can install it using Composer. Note
that the FOSHttpCache_ library needs a ``psr/http-message-implementation`` and
``php-http/client-implementation``. If your project does not contain one,
composer will complain that it did not find ``psr/http-message-implementation``.

To install the bundle together with Symfony HttpClient, run:

.. code-block:: bash

    $ composer require friendsofsymfony/http-cache-bundle symfony/http-client nyholm/psr7 guzzlehttp/promises

If you want to use something else than Symfony HttpClient, see Packagist for a list of
available `client implementations`_.

For most features, you also need to :ref:`configure a caching proxy <foshttpcache:proxy-configuration>`.

.. _requirements:

Optional Dependencies
---------------------

ExpressionLanguage
~~~~~~~~~~~~~~~~~~

If you wish to use expressions in your :doc:`attributes <reference/attributes>`,
you need Symfony’s ExpressionLanguage_ component. Make sure it is part of your application with:

.. code-block:: bash

    $ composer require symfony/expression-language

Configuration
-------------

Now you can configure the bundle under the ``fos_http_cache`` key. The
:doc:`features` section introduces the bundle’s features. The
:doc:`reference/configuration` section lists all configuration options.

Functionality
-------------

This table shows where you can find specific functions.

========================= ==================================== ==================================================== ==============================================
Functionality             Attributes                           Configuration                                        Manually
========================= ==================================== ==================================================== ==============================================
Set Cache-Control headers (`Symfony cache attributes`_)        :doc:`rules <reference/configuration/headers>`       (`Symfony cache control`_)
Tag and invalidate        :doc:`#[Tag] </features/tagging>`    :doc:`rules <reference/configuration/tags>`          :doc:`cache manager <reference/cache-manager>`
Invalidate routes         :ref:`invalidateroute`               :ref:`invalidators <invalidation configuration>`     :doc:`cache manager <reference/cache-manager>`
Invalidate paths          :ref:`invalidatepath`                :ref:`invalidators <invalidation configuration>`     :doc:`cache manager <reference/cache-manager>`
========================= ==================================== ==================================================== ==============================================

License
-------

This bundle is released under the MIT license.

.. literalinclude:: ../../LICENSE
    :language: none

.. _Packagist: https://packagist.org/packages/friendsofsymfony/http-cache-bundle
.. _ExpressionLanguage: https://symfony.com/doc/current/components/expression_language.html
.. _Symfony cache attributes: https://symfony.com/doc/current/http_cache.html#making-your-responses-http-cacheable
.. _Symfony cache control: https://symfony.com/doc/current/http_cache.html#the-cache-control-header
.. _client implementations: https://packagist.org/providers/php-http/client-implementation