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

Open in your IDE?
  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. class Cache extends ConfigurationAnnotation
  21. {
  22.     /**
  23.      * The expiration date as a valid date for the strtotime() function.
  24.      *
  25.      * @var string
  26.      */
  27.     private $expires;
  29.     /**
  30.      * The number of seconds that the response is considered fresh by a private
  31.      * cache like a web browser.
  32.      *
  33.      * @var int
  34.      */
  35.     private $maxage;
  37.     /**
  38.      * The number of seconds that the response is considered fresh by a public
  39.      * cache like a reverse proxy cache.
  40.      *
  41.      * @var int
  42.      */
  43.     private $smaxage;
  45.     /**
  46.      * Whether the response is public or not.
  47.      *
  48.      * @var bool
  49.      */
  50.     private $public;
  52.     /**
  53.      * Whether or not the response must be revalidated.
  54.      *
  55.      * @var bool
  56.      */
  57.     private $mustRevalidate;
  59.     /**
  60.      * Additional "Vary:"-headers.
  61.      *
  62.      * @var array
  63.      */
  64.     private $vary;
  66.     /**
  67.      * An expression to compute the Last-Modified HTTP header.
  68.      *
  69.      * @var string
  70.      */
  71.     private $lastModified;
  73.     /**
  74.      * An expression to compute the ETag HTTP header.
  75.      *
  76.      * @var string
  77.      */
  78.     private $etag;
  80.     /**
  81.      * max-stale Cache-Control header
  82.      * It can be expressed in seconds or with a relative time format (1 day, 2 weeks, ...).
  83.      *
  84.      * @var int|string
  85.      */
  86.     private $maxStale;
  88.     /**
  89.      * Returns the expiration date for the Expires header field.
  90.      *
  91.      * @return string
  92.      */
  93.     public function getExpires()
  94.     {
  95.         return $this->expires;
  96.     }
  98.     /**
  99.      * Sets the expiration date for the Expires header field.
  100.      *
  101.      * @param string $expires A valid php date
  102.      */
  103.     public function setExpires($expires)
  104.     {
  105.         $this->expires = $expires;
  106.     }
  108.     /**
  109.      * Sets the number of seconds for the max-age cache-control header field.
  110.      *
  111.      * @param int $maxage A number of seconds
  112.      */
  113.     public function setMaxAge($maxage)
  114.     {
  115.         $this->maxage = $maxage;
  116.     }
  118.     /**
  119.      * Returns the number of seconds the response is considered fresh by a
  120.      * private cache.
  121.      *
  122.      * @return int
  123.      */
  124.     public function getMaxAge()
  125.     {
  126.         return $this->maxage;
  127.     }
  129.     /**
  130.      * Sets the number of seconds for the s-maxage cache-control header field.
  131.      *
  132.      * @param int $smaxage A number of seconds
  133.      */
  134.     public function setSMaxAge($smaxage)
  135.     {
  136.         $this->smaxage = $smaxage;
  137.     }
  139.     /**
  140.      * Returns the number of seconds the response is considered fresh by a
  141.      * public cache.
  142.      *
  143.      * @return int
  144.      */
  145.     public function getSMaxAge()
  146.     {
  147.         return $this->smaxage;
  148.     }
  150.     /**
  151.      * Returns whether or not a response is public.
  152.      *
  153.      * @return bool
  154.      */
  155.     public function isPublic()
  156.     {
  157.         return true === $this->public;
  158.     }
  160.     /**
  161.      * @return bool
  162.      */
  163.     public function mustRevalidate()
  164.     {
  165.         return true === $this->mustRevalidate;
  166.     }
  168.     /**
  169.      * Forces a response to be revalidated.
  170.      *
  171.      * @param bool $mustRevalidate
  172.      */
  173.     public function setMustRevalidate($mustRevalidate)
  174.     {
  175.         $this->mustRevalidate = (bool) $mustRevalidate;
  176.     }
  178.     /**
  179.      * Returns whether or not a response is private.
  180.      *
  181.      * @return bool
  182.      */
  183.     public function isPrivate()
  184.     {
  185.         return false === $this->public;
  186.     }
  188.     /**
  189.      * Sets a response public.
  190.      *
  191.      * @param bool $public A boolean value
  192.      */
  193.     public function setPublic($public)
  194.     {
  195.         $this->public = (bool) $public;
  196.     }
  198.     /**
  199.      * Returns the custom "Vary"-headers.
  200.      *
  201.      * @return array
  202.      */
  203.     public function getVary()
  204.     {
  205.         return $this->vary;
  206.     }
  208.     /**
  209.      * Add additional "Vary:"-headers.
  210.      *
  211.      * @param array $vary
  212.      */
  213.     public function setVary($vary)
  214.     {
  215.         $this->vary = $vary;
  216.     }
  218.     /**
  219.      * Sets the "Last-Modified"-header expression.
  220.      *
  221.      * @param string $expression
  222.      */
  223.     public function setLastModified($expression)
  224.     {
  225.         $this->lastModified = $expression;
  226.     }
  228.     /**
  229.      * Returns the "Last-Modified"-header expression.
  230.      *
  231.      * @return string
  232.      */
  233.     public function getLastModified()
  234.     {
  235.         return $this->lastModified;
  236.     }
  238.     /**
  239.      * Sets the "ETag"-header expression.
  240.      *
  241.      * @param string $expression
  242.      */
  243.     public function setEtag($expression)
  244.     {
  245.         $this->etag = $expression;
  246.     }
  248.     /**
  249.      * Returns the "ETag"-header expression.
  250.      *
  251.      * @return string
  252.      */
  253.     public function getEtag()
  254.     {
  255.         return $this->etag;
  256.     }
  258.     /**
  259.      * @return int|string
  260.      */
  261.     public function getMaxStale()
  262.     {
  263.         return $this->maxStale;
  264.     }
  266.     /**
  267.      * Sets the number of seconds for the max-stale cache-control header field.
  268.      *
  269.      * @param int|string $maxStale A number of seconds
  270.      */
  271.     public function setMaxStale($maxStale)
  272.     {
  273.         $this->maxStale = $maxStale;
  274.     }
  276.     /**
  277.      * Returns the annotation alias name.
  278.      *
  279.      * @return string
  280.      *
  281.      * @see ConfigurationInterface
  282.      */
  283.     public function getAliasName()
  284.     {
  285.         return 'cache';
  286.     }
  288.     /**
  289.      * Only one cache directive is allowed.
  290.      *
  291.      * @return bool
  292.      *
  293.      * @see ConfigurationInterface
  294.      */
  295.     public function allowArray()
  296.     {
  297.         return false;
  298.     }
  299. }