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

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 Commercial License (PCL)
  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 PCL
  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/attributes. The annotation/attribute 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.  * @deprecated use Pimcore\Controller\Attribute\ResponseHeader instead.
  32.  */
  33. class ResponseHeader extends ConfigurationAnnotation
  34. {
  35.     /**
  36.      * @var string
  37.      */
  38.     protected $key;
  40.     /**
  41.      * @var string|array
  42.      */
  43.     protected $values;
  45.     /**
  46.      * @var bool
  47.      */
  48.     protected $replace = false;
  50.     /**
  51.      * @param string|array|null $key
  52.      * @param string|array $values
  53.      * @param bool $replace
  54.      */
  55.     public function __construct($key = null, $values = '', $replace = false)
  56.     {
  57.         if (is_array($key)) {
  58.             // value is the default key if attribute was called without assignment
  59.             // e.g. #[ResponseHeader("X-Foo")] instead of #[ResponseHeader(key="X-Foo")]
  60.             if (isset($key['value'])) {
  61.                 $key['key'] = $key['value'];
  62.                 unset($key['value']);
  63.             }
  65.             parent::__construct($key);
  66.         } else {
  67.             $this->key = $key;
  68.             $this->values = $values;
  69.             $this->replace = $replace;
  70.         }
  72.         if (empty($this->key)) {
  73.             throw new \InvalidArgumentException('The ResponseHeader Annotation/Attribute needs at least a key to be set');
  74.         }
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      */
  80.     public function getAliasName(): string
  81.     {
  82.         return 'response_header';
  83.     }
  85.     /**
  86.      * {@inheritdoc}
  87.      */
  88.     public function allowArray(): bool
  89.     {
  90.         return true;
  91.     }
  93.     /**
  94.      * @return string
  95.      */
  96.     public function getKey(): string
  97.     {
  98.         return $this->key;
  99.     }
  101.     /**
  102.      * @param string $key
  103.      */
  104.     public function setKey(string $key)
  105.     {
  106.         $this->key = $key;
  107.     }
  109.     /**
  110.      * @return array|string
  111.      */
  112.     public function getValues()
  113.     {
  114.         return $this->values;
  115.     }
  117.     /**
  118.      * @param array|string $values
  119.      */
  120.     public function setValues($values)
  121.     {
  122.         $this->values = $values;
  123.     }
  125.     /**
  126.      * @return bool
  127.      */
  128.     public function getReplace(): bool
  129.     {
  130.         return $this->replace;
  131.     }
  133.     /**
  134.      * @param bool $replace
  135.      */
  136.     public function setReplace(bool $replace)
  137.     {
  138.         $this->replace = $replace;
  139.     }
  140. }