vendor/symfony/cache/Marshaller/DefaultMarshaller.php line 85

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. use Symfony\Component\Cache\Exception\CacheException;
  16. /**
  17.  * Serializes/unserializes values using igbinary_serialize() if available, serialize() otherwise.
  18.  *
  19.  * @author Nicolas Grekas <p@tchwork.com>
  20.  */
  21. class DefaultMarshaller implements MarshallerInterface
  22. {
  23.     private $useIgbinarySerialize = true;
  24.     private $throwOnSerializationFailure;
  26.     public function __construct(bool $useIgbinarySerialize = null, bool $throwOnSerializationFailure = false)
  27.     {
  28.         if (null === $useIgbinarySerialize) {
  29.             $useIgbinarySerialize = \extension_loaded('igbinary') && (\PHP_VERSION_ID < 70400 || version_compare('3.1.6', phpversion('igbinary'), '<='));
  30.         } elseif ($useIgbinarySerialize && (!\extension_loaded('igbinary') || (\PHP_VERSION_ID >= 70400 && version_compare('3.1.6', phpversion('igbinary'), '>')))) {
  31.             throw new CacheException(\extension_loaded('igbinary') && \PHP_VERSION_ID >= 70400 ? 'Please upgrade the "igbinary" PHP extension to v3.1.6 or higher.' : 'The "igbinary" PHP extension is not loaded.');
  32.         }
  33.         $this->useIgbinarySerialize = $useIgbinarySerialize;
  34.         $this->throwOnSerializationFailure = $throwOnSerializationFailure;
  35.     }
  37.     /**
  38.      * {@inheritdoc}
  39.      */
  40.     public function marshall(array $values, ?array &$failed): array
  41.     {
  42.         $serialized = $failed = [];
  44.         foreach ($values as $id => $value) {
  45.             try {
  46.                 if ($this->useIgbinarySerialize) {
  47.                     $serialized[$id] = igbinary_serialize($value);
  48.                 } else {
  49.                     $serialized[$id] = serialize($value);
  50.                 }
  51.             } catch (\Exception $e) {
  52.                 if ($this->throwOnSerializationFailure) {
  53.                     throw new \ValueError($e->getMessage(), 0, $e);
  54.                 }
  55.                 $failed[] = $id;
  56.             }
  57.         }
  59.         return $serialized;
  60.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      */
  65.     public function unmarshall(string $value)
  66.     {
  67.         if ('b:0;' === $value) {
  68.             return false;
  69.         }
  70.         if ('N;' === $value) {
  71.             return null;
  72.         }
  73.         static $igbinaryNull;
  74.         if ($value === ($igbinaryNull ?? $igbinaryNull = \extension_loaded('igbinary') ? igbinary_serialize(null) : false)) {
  75.             return null;
  76.         }
  77.         $unserializeCallbackHandler = ini_set('unserialize_callback_func', __CLASS__.'::handleUnserializeCallback');
  78.         try {
  79.             if (':' === ($value[1] ?? ':')) {
  80.                 if (false !== $value = unserialize($value)) {
  81.                     return $value;
  82.                 }
  83.             } elseif (false === $igbinaryNull) {
  84.                 throw new \RuntimeException('Failed to unserialize values, did you forget to install the "igbinary" extension?');
  85.             } elseif (null !== $value = igbinary_unserialize($value)) {
  86.                 return $value;
  87.             }
  89.             throw new \DomainException(error_get_last() ? error_get_last()['message'] : 'Failed to unserialize values.');
  90.         } catch (\Error $e) {
  91.             throw new \ErrorException($e->getMessage(), $e->getCode(), \E_ERROR, $e->getFile(), $e->getLine());
  92.         } finally {
  93.             ini_set('unserialize_callback_func', $unserializeCallbackHandler);
  94.         }
  95.     }
  97.     /**
  98.      * @internal
  99.      */
  100.     public static function handleUnserializeCallback(string $class)
  101.     {
  102.         throw new \DomainException('Class not found: '.$class);
  103.     }
  104. }