vendor/friendsofsymfony/http-cache-bundle/src/Configuration/Tag.php line 23

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSHttpCacheBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.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 FOS\HttpCacheBundle\Configuration;
  14. use FOS\HttpCacheBundle\Exception\InvalidTagException;
  15. use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationAnnotation;
  16. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  17. use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
  19. /**
  20.  * @Annotation
  21.  */
  22. #[\Attribute(\Attribute::IS_REPEATABLE | \Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD)]
  23. class Tag extends ConfigurationAnnotation
  24. {
  25.     private $tags;
  27.     private $expression;
  29.     public function __construct(
  30.         $data = [],
  31.         $expression = null
  32.     ) {
  33.         $values = [];
  34.         if (is_string($data)) {
  35.             $values['value'] = $data;
  36.         } else {
  37.             $values = $data;
  38.         }
  40.         $values['expression'] = $values['expression'] ?? $expression;
  42.         parent::__construct($values);
  43.     }
  45.     /**
  46.      * Handle tags given without explicit key.
  47.      *
  48.      * @param string|array $data
  49.      */
  50.     public function setValue($data)
  51.     {
  52.         $this->setTags(is_array($data) ? $data : [$data]);
  53.     }
  55.     /**
  56.      * @param mixed $expression
  57.      */
  58.     public function setExpression($expression)
  59.     {
  60.         // @codeCoverageIgnoreStart
  61.         if (!class_exists(ExpressionLanguage::class)) {
  62.             throw new InvalidConfigurationException('@Tag param uses an expression but the ExpressionLanguage is not available.');
  63.         }
  64.         // @codeCoverageIgnoreEnd
  65.         $this->expression = $expression;
  66.     }
  68.     /**
  69.      * @return mixed
  70.      */
  71.     public function getExpression()
  72.     {
  73.         return $this->expression;
  74.     }
  76.     public function setTags(array $tags)
  77.     {
  78.         foreach ($tags as $tag) {
  79.             if (false !== \strpos($tag, ',')) {
  80.                 throw new InvalidTagException($tag, ',');
  81.             }
  82.         }
  84.         $this->tags = $tags;
  85.     }
  87.     public function getTags()
  88.     {
  89.         return $this->tags;
  90.     }
  92.     /**
  93.      * {@inheritdoc}
  94.      */
  95.     public function getAliasName()
  96.     {
  97.         return 'tag';
  98.     }
  100.     /**
  101.      * {@inheritdoc}
  102.      */
  103.     public function allowArray()
  104.     {
  105.         return true;
  106.     }
  107. }