vendor/sensio/framework-extra-bundle/src/Configuration/Cache.php line 21

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Sensio\Bundle\FrameworkExtraBundle\Configuration;
  14. /**
  15.  * The Cache class handles the Cache annotation parts.
  16.  *
  17.  * @author Fabien Potencier <fabien@symfony.com>
  18.  * @Annotation
  19.  */
  20. #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD)]
  21. class Cache extends ConfigurationAnnotation
  22. {
  23.     /**
  24.      * The expiration date as a valid date for the strtotime() function.
  25.      *
  26.      * @var string
  27.      */
  28.     private $expires;
  30.     /**
  31.      * The number of seconds that the response is considered fresh by a private
  32.      * cache like a web browser.
  33.      *
  34.      * @var int|string|null
  35.      */
  36.     private $maxage;
  38.     /**
  39.      * The number of seconds that the response is considered fresh by a public
  40.      * cache like a reverse proxy cache.
  41.      *
  42.      * @var int|string|null
  43.      */
  44.     private $smaxage;
  46.     /**
  47.      * Whether the response is public or not.
  48.      *
  49.      * @var bool
  50.      */
  51.     private $public;
  53.     /**
  54.      * Whether or not the response must be revalidated.
  55.      *
  56.      * @var bool
  57.      */
  58.     private $mustRevalidate;
  60.     /**
  61.      * Additional "Vary:"-headers.
  62.      *
  63.      * @var array
  64.      */
  65.     private $vary;
  67.     /**
  68.      * An expression to compute the Last-Modified HTTP header.
  69.      *
  70.      * @var string
  71.      */
  72.     private $lastModified;
  74.     /**
  75.      * An expression to compute the ETag HTTP header.
  76.      *
  77.      * @var string
  78.      */
  79.     private $etag;
  81.     /**
  82.      * max-stale Cache-Control header
  83.      * It can be expressed in seconds or with a relative time format (1 day, 2 weeks, ...).
  84.      *
  85.      * @var int|string
  86.      */
  87.     private $maxStale;
  89.     /**
  90.      * stale-while-revalidate Cache-Control header
  91.      * It can be expressed in seconds or with a relative time format (1 day, 2 weeks, ...).
  92.      *
  93.      * @var int|string
  94.      */
  95.     private $staleWhileRevalidate;
  97.     /**
  98.      * stale-if-error Cache-Control header
  99.      * It can be expressed in seconds or with a relative time format (1 day, 2 weeks, ...).
  100.      *
  101.      * @var int|string
  102.      */
  103.     private $staleIfError;
  105.     /**
  106.      * @param int|string|null $maxage
  107.      * @param int|string|null $smaxage
  108.      * @param int|string|null $maxstale
  109.      * @param int|string|null $staleWhileRevalidate
  110.      * @param int|string|null $staleIfError
  111.      */
  112.     public function __construct(
  113.         array $values = [],
  114.         string $expires = null,
  115.         $maxage = null,
  116.         $smaxage = null,
  117.         bool $public = null,
  118.         bool $mustRevalidate = null,
  119.         array $vary = null,
  120.         string $lastModified = null,
  121.         string $etag = null,
  122.         $maxstale = null,
  123.         $staleWhileRevalidate = null,
  124.         $staleIfError = null
  125.     ) {
  126.         $values['expires'] = $values['expires'] ?? $expires;
  127.         $values['maxage'] = $values['maxage'] ?? $maxage;
  128.         $values['smaxage'] = $values['smaxage'] ?? $smaxage;
  129.         $values['public'] = $values['public'] ?? $public;
  130.         $values['mustRevalidate'] = $values['mustRevalidate'] ?? $mustRevalidate;
  131.         $values['vary'] = $values['vary'] ?? $vary;
  132.         $values['lastModified'] = $values['lastModified'] ?? $lastModified;
  133.         $values['Etag'] = $values['Etag'] ?? $etag;
  134.         $values['maxstale'] = $values['maxstale'] ?? $maxstale;
  135.         $values['staleWhileRevalidate'] = $values['staleWhileRevalidate'] ?? $staleWhileRevalidate;
  136.         $values['staleIfError'] = $values['staleIfError'] ?? $staleIfError;
  138.         $values = array_filter($values, function ($v) {
  139.             return null !== $v;
  140.         });
  141.         parent::__construct($values);
  142.     }
  144.     /**
  145.      * Returns the expiration date for the Expires header field.
  146.      *
  147.      * @return string
  148.      */
  149.     public function getExpires()
  150.     {
  151.         return $this->expires;
  152.     }
  154.     /**
  155.      * Sets the expiration date for the Expires header field.
  156.      *
  157.      * @param string $expires A valid php date
  158.      */
  159.     public function setExpires($expires)
  160.     {
  161.         $this->expires = $expires;
  162.     }
  164.     /**
  165.      * Sets the number of seconds for the max-age cache-control header field.
  166.      *
  167.      * @param int $maxage A number of seconds
  168.      */
  169.     public function setMaxAge($maxage)
  170.     {
  171.         $this->maxage = $maxage;
  172.     }
  174.     /**
  175.      * Returns the number of seconds the response is considered fresh by a
  176.      * private cache.
  177.      *
  178.      * @return int
  179.      */
  180.     public function getMaxAge()
  181.     {
  182.         return $this->maxage;
  183.     }
  185.     /**
  186.      * Sets the number of seconds for the s-maxage cache-control header field.
  187.      *
  188.      * @param int $smaxage A number of seconds
  189.      */
  190.     public function setSMaxAge($smaxage)
  191.     {
  192.         $this->smaxage = $smaxage;
  193.     }
  195.     /**
  196.      * Returns the number of seconds the response is considered fresh by a
  197.      * public cache.
  198.      *
  199.      * @return int
  200.      */
  201.     public function getSMaxAge()
  202.     {
  203.         return $this->smaxage;
  204.     }
  206.     /**
  207.      * Returns whether or not a response is public.
  208.      *
  209.      * @return bool
  210.      */
  211.     public function isPublic()
  212.     {
  213.         return true === $this->public;
  214.     }
  216.     /**
  217.      * @return bool
  218.      */
  219.     public function mustRevalidate()
  220.     {
  221.         return true === $this->mustRevalidate;
  222.     }
  224.     /**
  225.      * Forces a response to be revalidated.
  226.      *
  227.      * @param bool $mustRevalidate
  228.      */
  229.     public function setMustRevalidate($mustRevalidate)
  230.     {
  231.         $this->mustRevalidate = (bool) $mustRevalidate;
  232.     }
  234.     /**
  235.      * Returns whether or not a response is private.
  236.      *
  237.      * @return bool
  238.      */
  239.     public function isPrivate()
  240.     {
  241.         return false === $this->public;
  242.     }
  244.     /**
  245.      * Sets a response public.
  246.      *
  247.      * @param bool $public A boolean value
  248.      */
  249.     public function setPublic($public)
  250.     {
  251.         $this->public = (bool) $public;
  252.     }
  254.     /**
  255.      * Returns the custom "Vary"-headers.
  256.      *
  257.      * @return array
  258.      */
  259.     public function getVary()
  260.     {
  261.         return $this->vary;
  262.     }
  264.     /**
  265.      * Add additional "Vary:"-headers.
  266.      *
  267.      * @param array $vary
  268.      */
  269.     public function setVary($vary)
  270.     {
  271.         $this->vary = $vary;
  272.     }
  274.     /**
  275.      * Sets the "Last-Modified"-header expression.
  276.      *
  277.      * @param string $expression
  278.      */
  279.     public function setLastModified($expression)
  280.     {
  281.         $this->lastModified = $expression;
  282.     }
  284.     /**
  285.      * Returns the "Last-Modified"-header expression.
  286.      *
  287.      * @return string
  288.      */
  289.     public function getLastModified()
  290.     {
  291.         return $this->lastModified;
  292.     }
  294.     /**
  295.      * Sets the "ETag"-header expression.
  296.      *
  297.      * @param string $expression
  298.      */
  299.     public function setEtag($expression)
  300.     {
  301.         $this->etag = $expression;
  302.     }
  304.     /**
  305.      * Returns the "ETag"-header expression.
  306.      *
  307.      * @return string
  308.      */
  309.     public function getEtag()
  310.     {
  311.         return $this->etag;
  312.     }
  314.     /**
  315.      * @return int|string
  316.      */
  317.     public function getMaxStale()
  318.     {
  319.         return $this->maxStale;
  320.     }
  322.     /**
  323.      * Sets the number of seconds for the max-stale cache-control header field.
  324.      *
  325.      * @param int|string $maxStale A number of seconds
  326.      */
  327.     public function setMaxStale($maxStale)
  328.     {
  329.         $this->maxStale = $maxStale;
  330.     }
  332.     /**
  333.      * @return int|string
  334.      */
  335.     public function getStaleWhileRevalidate()
  336.     {
  337.         return $this->staleWhileRevalidate;
  338.     }
  340.     /**
  341.      * @param int|string $staleWhileRevalidate
  342.      *
  343.      * @return self
  344.      */
  345.     public function setStaleWhileRevalidate($staleWhileRevalidate)
  346.     {
  347.         $this->staleWhileRevalidate = $staleWhileRevalidate;
  349.         return $this;
  350.     }
  352.     /**
  353.      * @return int|string
  354.      */
  355.     public function getStaleIfError()
  356.     {
  357.         return $this->staleIfError;
  358.     }
  360.     /**
  361.      * @param int|string $staleIfError
  362.      *
  363.      * @return self
  364.      */
  365.     public function setStaleIfError($staleIfError)
  366.     {
  367.         $this->staleIfError = $staleIfError;
  369.         return $this;
  370.     }
  372.     /**
  373.      * Returns the annotation alias name.
  374.      *
  375.      * @return string
  376.      *
  377.      * @see ConfigurationInterface
  378.      */
  379.     public function getAliasName()
  380.     {
  381.         return 'cache';
  382.     }
  384.     /**
  385.      * Only one cache directive is allowed.
  386.      *
  387.      * @return bool
  388.      *
  389.      * @see ConfigurationInterface
  390.      */
  391.     public function allowArray()
  392.     {
  393.         return false;
  394.     }
  395. }