<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\HttpFoundation;
/**
* ResponseHeaderBag is a container for Response HTTP headers.
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
class ResponseHeaderBag extends HeaderBag
{
protected $computedCacheControl = array();
* Constructor.
* @param array $headers An array of HTTP headers
public function __construct(array $parameters = array())
// this line is not necessary, but including it avoids any stupid
// errors if we add code to the parent's constructor
parent::__construct();
$this->replace($parameters);
}
* {@inheritdoc}
public function replace(array $headers = array())
parent::replace($headers);
if (!isset($this->headers['cache-control'])) {
$this->set('cache-control', '');
public function set($key, $values, $replace = true)
parent::set($key, $values, $replace);
// ensure the cache-control header has sensible defaults
if ('cache-control' === strtr(strtolower($key), '_', '-')) {
$computed = $this->computeCacheControlValue();
$this->headers['cache-control'] = array($computed);
$this->computedCacheControl = $this->parseCacheControl($computed);
public function remove($key)
parent::remove($key);
$this->computedCacheControl = array();
public function hasCacheControlDirective($key)
return array_key_exists($key, $this->computedCacheControl);
public function getCacheControlDirective($key)
return array_key_exists($key, $this->computedCacheControl) ? $this->computedCacheControl[$key] : null;
* Clears a cookie in the browser
* @param string $name
* @param string $path
* @param string $domain
* @return void
public function clearCookie($name, $path = null, $domain = null)
$this->setCookie(new Cookie($name, null, time() - 86400, $path, $domain));
* Returns the calculated value of the cache-control header.
* This considers several other headers and calculates or modifies the
* cache-control header to a sensible, conservative value.
* @return string
protected function computeCacheControlValue()
if (!$this->cacheControl && !$this->has('ETag') && !$this->has('Last-Modified') && !$this->has('Expires')) {
return 'no-cache';
if (!$this->cacheControl) {
// conservative by default
return 'private, max-age=0, must-revalidate';
$header = $this->getCacheControlHeader();
if (isset($this->cacheControl['public']) || isset($this->cacheControl['private'])) {
return $header;
// public if s-maxage is defined, private otherwise
if (!isset($this->cacheControl['s-maxage'])) {
return $header.', private';