@Cache

HTTP Expiration Strategies

The @Cache annotation allows to define HTTP caching:

1
2
3
4
5
6
7
8

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;

/**
 * @Cache(expires="tomorrow", public=true)
 */
public function index()
{
}

1
2
3
4
5
6

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;

#[Cache(expires: 'tomorrow', public: true)]
public function index()
{
}

You can also use the annotation on a class to define caching for all actions of a controller:

1
2
3
4
5
6

/**
 * @Cache(expires="tomorrow", public=true)
 */
class BlogController extends Controller
{
}

1
2
3
4

#[Cache(expires: 'tomorrow', public: true)]
class BlogController extends Controller
{
}

When there is a conflict between the class configuration and the method configuration, the latter overrides the former:

1
2
3
4
5
6
7
8
9
10
11
12

/**
 * @Cache(expires="tomorrow")
 */
class BlogController extends Controller
{
    /**
     * @Cache(expires="+2 days")
     */
    public function index()
    {
    }
}

1
2
3
4
5
6
7
8

#[Cache(expires: 'tomorrow')]
class BlogController extends Controller
{
    #[Cache(expires: '+2 days')]
    public function index()
    {
    }
}

HTTP Validation Strategies

The lastModified and Etag attributes manage the HTTP validation cache headers. lastModified adds a Last-Modified header to Responses and Etag adds an Etag header.

Both automatically trigger the logic to return a 304 response when the response is not modified (in this case, the controller is not called):

1
2
3
4
5
6
7
8
9
10

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;

/**
 * @Cache(lastModified="post.getUpdatedAt()", Etag="'Post' ~ post.getId() ~ post.getUpdatedAt().getTimestamp()")
 */
public function index(Post $post)
{
    // your code
    // won't be called in case of a 304
}

1
2
3
4
5
6
7
8

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;

#[Cache(lastModified: 'post.getUpdatedAt()', etag: "'Post' ~ post.getId() ~ post.getUpdatedAt().getTimestamp()")]
public function index(Post $post)
{
    // your code
    // won't be called in case of a 304
}

It's roughly doing the same as the following code:

1
2
3
4
5
6
7
8
9
10

public function my(Request $request, Post $post)
{
    $response = new Response();
    $response->setLastModified($post->getUpdatedAt());
    if ($response->isNotModified($request)) {
        return $response;
    }

    // your code
}

Attributes

Here is a list of accepted attributes and their HTTP header equivalent: