vendor/pimcore/pimcore/lib/Targeting/Storage/Cookie/AbstractCookieSaveHandler.php line 81

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\Targeting\Storage\Cookie;
  20. use Symfony\Component\HttpFoundation\Cookie;
  21. use Symfony\Component\HttpFoundation\Request;
  22. use Symfony\Component\HttpFoundation\Response;
  23. use Symfony\Component\OptionsResolver\OptionsResolver;
  25. abstract class AbstractCookieSaveHandler implements CookieSaveHandlerInterface
  26. {
  27.     /**
  28.      * @var array
  29.      */
  30.     protected $options = [];
  32.     /**
  33.      * @param array $options
  34.      */
  35.     public function __construct(array $options = [])
  36.     {
  37.         $resolver = new OptionsResolver();
  38.         $this->configureOptions($resolver);
  40.         $this->options = $resolver->resolve($options);
  41.     }
  43.     protected function configureOptions(OptionsResolver $resolver)
  44.     {
  45.         $resolver->setDefaults([
  46.             'domain' => null,
  47.             'secure' => false,
  48.             'httpOnly' => true
  49.         ]);
  51.         $resolver->setAllowedTypes('domain', ['null', 'string']);
  52.         $resolver->setAllowedTypes('secure', ['bool']);
  53.         $resolver->setAllowedTypes('httpOnly', ['bool']);
  54.     }
  56.     /**
  57.      * @inheritdoc
  58.      */
  59.     public function load(Request $request, string $scope, string $name): array
  60.     {
  61.         $data = $request->cookies->get($name, null);
  62.         $result = $this->parseData($scope, $name, $data);
  64.         return $result;
  65.     }
  67.     /**
  68.      * @inheritdoc
  69.      */
  70.     public function save(Response $response, string $scope, string $name, $expire, $data)
  71.     {
  72.         $value = $this->prepareData($scope, $name, $expire, $data);
  74.         $response->headers->setCookie(new Cookie(
  75.             $name,
  76.             $value,
  77.             $expire,
  78.             '/',
  79.             null,
  80.             false,
  81.             true
  82.         ));
  83.     }
  85.     /**
  86.      * Parse loaded data
  87.      *
  88.      * @param string $scope
  89.      * @param string $name
  90.      * @param string|null $data
  91.      *
  92.      * @return array
  93.      */
  94.     abstract protected function parseData(string $scope, string $name, $data): array;
  96.     /**
  97.      * Prepare data for saving
  98.      *
  99.      * @param string $scope
  100.      * @param string $name
  101.      * @param int|string|\DateTimeInterface $expire
  102.      * @param array|null $data
  103.      *
  104.      * @return string|null
  105.      */
  106.     abstract protected function prepareData(string $scope, string $name, $expire, $data);
  107. }