vendor/symfony/cache/Marshaller/TagAwareMarshaller.php line 84

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 Symfony\Component\Cache\Marshaller;
  14. /**
  15.  * A marshaller optimized for data structures generated by AbstractTagAwareAdapter.
  16.  *
  17.  * @author Nicolas Grekas <p@tchwork.com>
  18.  */
  19. class TagAwareMarshaller implements MarshallerInterface
  20. {
  21.     private $marshaller;
  23.     public function __construct(?MarshallerInterface $marshaller = null)
  24.     {
  25.         $this->marshaller = $marshaller ?? new DefaultMarshaller();
  26.     }
  28.     /**
  29.      * {@inheritdoc}
  30.      */
  31.     public function marshall(array $values, ?array &$failed): array
  32.     {
  33.         $failed = $notSerialized = $serialized = [];
  35.         foreach ($values as $id => $value) {
  36.             if (\is_array($value) && \is_array($value['tags'] ?? null) && \array_key_exists('value', $value) && \count($value) === 2 + (\is_string($value['meta'] ?? null) && 8 === \strlen($value['meta']))) {
  37.                 // if the value is an array with keys "tags", "value" and "meta", use a compact serialization format
  38.                 // magic numbers in the form 9D-..-..-..-..-00-..-..-..-5F allow detecting this format quickly in unmarshall()
  40.                 $v = $this->marshaller->marshall($value, $f);
  42.                 if ($f) {
  43.                     $f = [];
  44.                     $failed[] = $id;
  45.                 } else {
  46.                     if ([] === $value['tags']) {
  47.                         $v['tags'] = '';
  48.                     }
  50.                     $serialized[$id] = "\x9D".($value['meta'] ?? "\0\0\0\0\0\0\0\0").pack('N', \strlen($v['tags'])).$v['tags'].$v['value'];
  51.                     $serialized[$id][9] = "\x5F";
  52.                 }
  53.             } else {
  54.                 // other arbitrary values are serialized using the decorated marshaller below
  55.                 $notSerialized[$id] = $value;
  56.             }
  57.         }
  59.         if ($notSerialized) {
  60.             $serialized += $this->marshaller->marshall($notSerialized, $f);
  61.             $failed = array_merge($failed, $f);
  62.         }
  64.         return $serialized;
  65.     }
  67.     /**
  68.      * {@inheritdoc}
  69.      */
  70.     public function unmarshall(string $value)
  71.     {
  72.         // detect the compact format used in marshall() using magic numbers in the form 9D-..-..-..-..-00-..-..-..-5F
  73.         if (13 >= \strlen($value) || "\x9D" !== $value[0] || "\0" !== $value[5] || "\x5F" !== $value[9]) {
  74.             return $this->marshaller->unmarshall($value);
  75.         }
  77.         // data consists of value, tags and metadata which we need to unpack
  78.         $meta = substr($value, 1, 12);
  79.         $meta[8] = "\0";
  80.         $tagLen = unpack('Nlen', $meta, 8)['len'];
  81.         $meta = substr($meta, 0, 8);
  83.         return [
  84.             'value' => $this->marshaller->unmarshall(substr($value, 13 + $tagLen)),
  85.             'tags' => $tagLen ? $this->marshaller->unmarshall(substr($value, 13, $tagLen)) : [],
  86.             'meta' => "\0\0\0\0\0\0\0\0" === $meta ? null : $meta,
  87.         ];
  88.     }
  89. }