vendor/pimcore/pimcore/lib/Controller/Configuration/ResponseHeader.php line 31

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Enterprise License (PEL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  16.  */
  18. namespace Pimcore\Controller\Configuration;
  20. use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationAnnotation;
  22. /**
  23.  * Allows to set HTTP headers on the response via annotation. The annotation will
  24.  * be processed by ResponseHeaderListener which will set the HTTP headers on the
  25.  * response.
  26.  *
  27.  * See ResponseHeaderBag for documentation on the fields.
  28.  *
  29.  * @Annotation
  30.  */
  31. class ResponseHeader extends ConfigurationAnnotation
  32. {
  33.     /**
  34.      * @var string
  35.      */
  36.     protected $key;
  38.     /**
  39.      * @var string|array
  40.      */
  41.     protected $values;
  43.     /**
  44.      * @var bool
  45.      */
  46.     protected $replace = false;
  48.     /**
  49.      * @param array $data
  50.      */
  51.     public function __construct(array $data)
  52.     {
  53.         // value is the default key if annotation was called without assignment
  54.         // e.g. @ResponseHeader("X-Foo") instead of @ResponseHeader(key="X-Foo")
  55.         if (isset($data['value'])) {
  56.             $data['key'] = $data['value'];
  57.             unset($data['value']);
  58.         }
  60.         parent::__construct($data);
  62.         if (empty($this->key)) {
  63.             throw new \InvalidArgumentException('The @ResponseHeaderAnnotation needs at least a key to be set');
  64.         }
  65.     }
  67.     /**
  68.      * @inheritDoc
  69.      */
  70.     public function getAliasName(): string
  71.     {
  72.         return 'response_header';
  73.     }
  75.     /**
  76.      * @inheritDoc
  77.      */
  78.     public function allowArray(): bool
  79.     {
  80.         return true;
  81.     }
  83.     /**
  84.      * @return string
  85.      */
  86.     public function getKey(): string
  87.     {
  88.         return $this->key;
  89.     }
  91.     /**
  92.      * @param string $key
  93.      */
  94.     public function setKey(string $key)
  95.     {
  96.         $this->key = $key;
  97.     }
  99.     /**
  100.      * @return array|string
  101.      */
  102.     public function getValues()
  103.     {
  104.         return $this->values;
  105.     }
  107.     /**
  108.      * @param array|string $values
  109.      */
  110.     public function setValues($values)
  111.     {
  112.         $this->values = $values;
  113.     }
  115.     /**
  116.      * @return bool
  117.      */
  118.     public function getReplace(): bool
  119.     {
  120.         return $this->replace;
  121.     }
  123.     /**
  124.      * @param bool $replace
  125.      */
  126.     public function setReplace(bool $replace)
  127.     {
  128.         $this->replace = $replace;
  129.     }
  130. }