Skip to content

Update http cache docs because index.php changed #11501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Update http cache docs because index.php changed #11501

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad2c130
merge relevant parts from origin/4.2 to prevent conflicts
choonge Apr 29, 2019
62b1ad5
Update http cache docs because index.php has changed
choonge Apr 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 33 additions & 17 deletions http_cache.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,22 +77,37 @@ but is a great way to start.

For details on setting up Varnish, see :doc:`/http_cache/varnish`.

Each application comes with a caching kernel (``AppCache``) that wraps the
default one (``AppKernel``). The caching Kernel *is* the reverse proxy.
To enable the proxy, first create a caching kernel::

To enable caching, modify the code of your front controller. You can also make these
changes to ``app_dev.php`` to add caching to the ``dev`` environment::
// src/CacheKernel.php
namespace App;

// web/app.php
use Symfony\Bundle\FrameworkBundle\HttpCache\HttpCache;

class CacheKernel extends HttpCache
{
}

Modify the code of your front controller to wrap the default kernel into the
caching kernel:

.. code-block:: diff

// public/index.php

+ use App\CacheKernel;
use App\Kernel;
use Symfony\Component\Debug\Debug;
use Symfony\Component\HttpFoundation\Request;

// ...
$kernel = new AppKernel('prod', false);
$kernel->loadClassCache();
$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);

// add (or uncomment) this new line!
// wrap the default AppKernel with the AppCache one
$kernel = new AppCache($kernel);
+ // Wrap the default Kernel with the CacheKernel one in 'prod' environment
+ $env = $_SERVER['APP_ENV'] ?? 'dev';
+ if ('prod' === $env) {
+ $kernel = new CacheKernel($kernel);
+ }

$request = Request::createFromGlobals();
// ...
Expand All @@ -114,15 +129,17 @@ from your application and returning them to the client.

error_log($kernel->getLog());

The ``AppCache`` object has a sensible default configuration, but it can be
The ``CacheKernel`` object has a sensible default configuration, but it can be
finely tuned via a set of options you can set by overriding the
:method:`Symfony\\Bundle\\FrameworkBundle\\HttpCache\\HttpCache::getOptions`
method::

// app/AppCache.php
// src/CacheKernel.php
namespace App;

use Symfony\Bundle\FrameworkBundle\HttpCache\HttpCache;

class AppCache extends HttpCache
class CacheKernel extends HttpCache
{
protected function getOptions()
{
Expand All @@ -136,10 +153,9 @@ method::
For a full list of the options and their meaning, see the
:method:`HttpCache::__construct() documentation <Symfony\\Component\\HttpKernel\\HttpCache\\HttpCache::__construct>`.

When you're in debug mode (either because your booting a ``debug`` kernel, like
in ``app_dev.php`` *or* you manually set the ``debug`` option to true), Symfony
automatically adds an ``X-Symfony-Cache`` header to the response. Use this to get
information about cache hits and misses.
When you're in debug mode (the second argument of ``Kernel`` constructor in the
front controller is ``true``), Symfony automatically adds an ``X-Symfony-Cache``
header to the response. Use this to get information about cache hits and misses.

.. _http-cache-symfony-versus-varnish:

Expand Down