changed Cache-Control default value behavior
The PHP native cache limiter feature has been disabled as this is now managed
by the HeaderBag class directly instead (see below.)
The HeaderBag class uses the following rules to define a sensible and
convervative default value for the Response 'Cache-Control' header:
* If no cache header is defined ('Cache-Control', 'ETag', 'Last-Modified',
and 'Expires'), 'Cache-Control' is set to 'no-cache';
* If 'Cache-Control' is empty, its value is set to "private, max-age=0,
must-revalidate";
* But if at least one 'Cache-Control' directive is set, and no 'public' or
'private' directives have been explicitely added, Symfony2 adds the
'private' directive automatically (except when 's-maxage' is set.)
So, remember to explicitly add the 'public' directive to 'Cache-Control' when
you want shared caches to store your application resources:
// The Response is private by default
$response->setEtag($etag);
$response->setLastModified($date);
$response->setMaxAge(10);
// Change the Response to be public
$response->setPublic();
// Set cache settings in one call
$response->setCache(array(
'etag' => $etag,
'last_modified' => $date,
'max_age' => 10,
'public' => true,
));
2010-11-10 09:48:22 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Symfony\Component\HttpFoundation;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* ResponseHeaderBag is a container for Response HTTP headers.
|
|
|
|
*
|
|
|
|
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*/
|
|
|
|
class ResponseHeaderBag extends HeaderBag
|
|
|
|
{
|
|
|
|
protected $computedCacheControl = array();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
|
|
|
public function replace(array $headers = array())
|
|
|
|
{
|
|
|
|
parent::replace($headers);
|
|
|
|
|
|
|
|
if (!isset($this->headers['cache-control'])) {
|
|
|
|
$this->set('cache-control', '');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
|
|
|
public function set($key, $values, $replace = true)
|
|
|
|
{
|
|
|
|
parent::set($key, $values, $replace);
|
|
|
|
|
|
|
|
if ('cache-control' === strtr(strtolower($key), '_', '-')) {
|
|
|
|
$computed = $this->computeCacheControlValue();
|
|
|
|
$this->headers['cache-control'] = array($computed);
|
|
|
|
$this->computedCacheControl = $this->parseCacheControl($computed);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
|
|
|
public function delete($key)
|
|
|
|
{
|
|
|
|
parent::delete($key);
|
|
|
|
|
|
|
|
if ('cache-control' === strtr(strtolower($key), '_', '-')) {
|
|
|
|
$this->computedCacheControl = array();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
|
|
|
public function setCookie($name, $value, $domain = null, $expires = null, $path = '/', $secure = false, $httponly = true)
|
|
|
|
{
|
2010-11-21 12:32:58 +00:00
|
|
|
$this->validateCookie($name, $value);
|
changed Cache-Control default value behavior
The PHP native cache limiter feature has been disabled as this is now managed
by the HeaderBag class directly instead (see below.)
The HeaderBag class uses the following rules to define a sensible and
convervative default value for the Response 'Cache-Control' header:
* If no cache header is defined ('Cache-Control', 'ETag', 'Last-Modified',
and 'Expires'), 'Cache-Control' is set to 'no-cache';
* If 'Cache-Control' is empty, its value is set to "private, max-age=0,
must-revalidate";
* But if at least one 'Cache-Control' directive is set, and no 'public' or
'private' directives have been explicitely added, Symfony2 adds the
'private' directive automatically (except when 's-maxage' is set.)
So, remember to explicitly add the 'public' directive to 'Cache-Control' when
you want shared caches to store your application resources:
// The Response is private by default
$response->setEtag($etag);
$response->setLastModified($date);
$response->setMaxAge(10);
// Change the Response to be public
$response->setPublic();
// Set cache settings in one call
$response->setCache(array(
'etag' => $etag,
'last_modified' => $date,
'max_age' => 10,
'public' => true,
));
2010-11-10 09:48:22 +00:00
|
|
|
|
|
|
|
$cookie = sprintf('%s=%s', $name, urlencode($value));
|
|
|
|
|
|
|
|
if (null !== $expires) {
|
|
|
|
if (is_numeric($expires)) {
|
|
|
|
$expires = (int) $expires;
|
|
|
|
} elseif ($expires instanceof \DateTime) {
|
|
|
|
$expires = $expires->getTimestamp();
|
|
|
|
} else {
|
|
|
|
$expires = strtotime($expires);
|
|
|
|
if (false === $expires || -1 == $expires) {
|
|
|
|
throw new \InvalidArgumentException(sprintf('The "expires" cookie parameter is not valid.', $expires));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$cookie .= '; expires='.substr(\DateTime::createFromFormat('U', $expires, new \DateTimeZone('UTC'))->format('D, d-M-Y H:i:s T'), 0, -5);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($domain) {
|
|
|
|
$cookie .= '; domain='.$domain;
|
|
|
|
}
|
|
|
|
|
|
|
|
$cookie .= '; path='.$path;
|
|
|
|
|
|
|
|
if ($secure) {
|
|
|
|
$cookie .= '; secure';
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($httponly) {
|
|
|
|
$cookie .= '; httponly';
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->set('Set-Cookie', $cookie, false);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
|
|
|
public function hasCacheControlDirective($key)
|
|
|
|
{
|
|
|
|
return array_key_exists($key, $this->computedCacheControl);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
|
|
|
public function getCacheControlDirective($key)
|
|
|
|
{
|
|
|
|
return array_key_exists($key, $this->computedCacheControl) ? $this->computedCacheControl[$key] : null;
|
|
|
|
}
|
|
|
|
|
|
|
|
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';
|
|
|
|
}
|
|
|
|
|
|
|
|
return $header;
|
|
|
|
}
|
|
|
|
}
|