class TraceableSerializer

Collects some data about serialization.

@author Mathias Arlaud <mathias.arlaud@gmail.com>

@final

Hierarchy

Expanded class hierarchy of TraceableSerializer

1 file declares its use of TraceableSerializer
SerializerDataCollector.php in vendor/symfony/serializer/DataCollector/SerializerDataCollector.php

File

vendor/symfony/serializer/Debug/TraceableSerializer.php, line 28

Namespace

Symfony\Component\Serializer\Debug
View source 
class TraceableSerializer implements SerializerInterface, NormalizerInterface, DenormalizerInterface, EncoderInterface, DecoderInterface {
    public const DEBUG_TRACE_ID = 'debug_trace_id';
    public function __construct(SerializerInterface&NormalizerInterface&DenormalizerInterface&EncoderInterface&DecoderInterface $serializer, SerializerDataCollector $dataCollector, string $serializerName = 'default') {
    }
    public function serialize(mixed $data, string $format, array $context = []) : string {
        $context[self::DEBUG_TRACE_ID] = $traceId = bin2hex(random_bytes(4));
        $startTime = microtime(true);
        $result = $this->serializer
            ->serialize($data, $format, $context);
        $time = microtime(true) - $startTime;
        $caller = $this->getCaller(__FUNCTION__, SerializerInterface::class);
        $this->dataCollector
            ->collectSerialize($traceId, $data, $format, $context, $time, $caller, $this->serializerName);
        return $result;
    }
    public function deserialize(mixed $data, string $type, string $format, array $context = []) : mixed {
        $context[self::DEBUG_TRACE_ID] = $traceId = bin2hex(random_bytes(4));
        $startTime = microtime(true);
        $result = $this->serializer
            ->deserialize($data, $type, $format, $context);
        $time = microtime(true) - $startTime;
        $caller = $this->getCaller(__FUNCTION__, SerializerInterface::class);
        $this->dataCollector
            ->collectDeserialize($traceId, $data, $type, $format, $context, $time, $caller, $this->serializerName);
        return $result;
    }
    public function normalize(mixed $object, ?string $format = null, array $context = []) : array|string|int|float|bool|\ArrayObject|null {
        $context[self::DEBUG_TRACE_ID] = $traceId = bin2hex(random_bytes(4));
        $startTime = microtime(true);
        $result = $this->serializer
            ->normalize($object, $format, $context);
        $time = microtime(true) - $startTime;
        $caller = $this->getCaller(__FUNCTION__, NormalizerInterface::class);
        $this->dataCollector
            ->collectNormalize($traceId, $object, $format, $context, $time, $caller, $this->serializerName);
        return $result;
    }
    public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []) : mixed {
        $context[self::DEBUG_TRACE_ID] = $traceId = bin2hex(random_bytes(4));
        $startTime = microtime(true);
        $result = $this->serializer
            ->denormalize($data, $type, $format, $context);
        $time = microtime(true) - $startTime;
        $caller = $this->getCaller(__FUNCTION__, DenormalizerInterface::class);
        $this->dataCollector
            ->collectDenormalize($traceId, $data, $type, $format, $context, $time, $caller, $this->serializerName);
        return $result;
    }
    public function encode(mixed $data, string $format, array $context = []) : string {
        $context[self::DEBUG_TRACE_ID] = $traceId = bin2hex(random_bytes(4));
        $startTime = microtime(true);
        $result = $this->serializer
            ->encode($data, $format, $context);
        $time = microtime(true) - $startTime;
        $caller = $this->getCaller(__FUNCTION__, EncoderInterface::class);
        $this->dataCollector
            ->collectEncode($traceId, $data, $format, $context, $time, $caller, $this->serializerName);
        return $result;
    }
    public function decode(string $data, string $format, array $context = []) : mixed {
        $context[self::DEBUG_TRACE_ID] = $traceId = bin2hex(random_bytes(4));
        $startTime = microtime(true);
        $result = $this->serializer
            ->decode($data, $format, $context);
        $time = microtime(true) - $startTime;
        $caller = $this->getCaller(__FUNCTION__, DecoderInterface::class);
        $this->dataCollector
            ->collectDecode($traceId, $data, $format, $context, $time, $caller, $this->serializerName);
        return $result;
    }
    public function getSupportedTypes(?string $format) : array {
        return $this->serializer
            ->getSupportedTypes($format);
    }
    public function supportsNormalization(mixed $data, ?string $format = null, array $context = []) : bool {
        return $this->serializer
            ->supportsNormalization($data, $format, $context);
    }
    public function supportsDenormalization(mixed $data, string $type, ?string $format = null, array $context = []) : bool {
        return $this->serializer
            ->supportsDenormalization($data, $type, $format, $context);
    }
    public function supportsEncoding(string $format, array $context = []) : bool {
        return $this->serializer
            ->supportsEncoding($format, $context);
    }
    public function supportsDecoding(string $format, array $context = []) : bool {
        return $this->serializer
            ->supportsDecoding($format, $context);
    }
    
    /**
     * Proxies all method calls to the original serializer.
     */
    public function __call(string $method, array $arguments) : mixed {
        return $this->serializer
            ->{$method}(...$arguments);
    }
    private function getCaller(string $method, string $interface) : array {
        $trace = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 8);
        $file = $trace[0]['file'];
        $line = $trace[0]['line'];
        for ($i = 1; $i < 8; ++$i) {
            if (isset($trace[$i]['class'], $trace[$i]['function']) && $method === $trace[$i]['function'] && is_a($trace[$i]['class'], $interface, true)) {
                $file = $trace[$i]['file'];
                $line = $trace[$i]['line'];
                break;
            }
        }
        $name = str_replace('\\', '/', $file);
        $name = substr($name, strrpos($name, '/') + 1);
        return compact('name', 'file', 'line');
    }

}

Members

Title Modifiers Object type Summary Overriden Title
DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS public constant
TraceableSerializer::DEBUG_TRACE_ID public constant
TraceableSerializer::decode public function Decodes a string into PHP data. Overrides DecoderInterface::decode
TraceableSerializer::denormalize public function Denormalizes data back into an object of the given class. Overrides DenormalizerInterface::denormalize
TraceableSerializer::deserialize public function Deserializes data into the given type. Overrides SerializerInterface::deserialize
TraceableSerializer::encode public function Encodes data into the given format. Overrides EncoderInterface::encode
TraceableSerializer::getCaller private function
TraceableSerializer::getSupportedTypes public function Returns the types potentially supported by this normalizer. Overrides NormalizerInterface::getSupportedTypes
TraceableSerializer::normalize public function Normalizes data into a set of arrays/scalars. Overrides NormalizerInterface::normalize
TraceableSerializer::serialize public function Serializes data in the appropriate format. Overrides SerializerInterface::serialize
TraceableSerializer::supportsDecoding public function Checks whether the deserializer can decode from given format. Overrides DecoderInterface::supportsDecoding
TraceableSerializer::supportsDenormalization public function Checks whether the given class is supported for denormalization by this normalizer. Overrides DenormalizerInterface::supportsDenormalization
TraceableSerializer::supportsEncoding public function Checks whether the serializer can encode to given format. Overrides EncoderInterface::supportsEncoding
TraceableSerializer::supportsNormalization public function Checks whether the given class is supported for normalization by this normalizer. Overrides NormalizerInterface::supportsNormalization
TraceableSerializer::__call public function Proxies all method calls to the original serializer.
TraceableSerializer::__construct public function