class TraceableEncoder

Collects some data about encoding.

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

@final

Hierarchy

Expanded class hierarchy of TraceableEncoder

2 files declare their use of TraceableEncoder
ChainEncoder.php in vendor/symfony/serializer/Encoder/ChainEncoder.php
SerializerPass.php in vendor/symfony/serializer/DependencyInjection/SerializerPass.php

File

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

Namespace

Symfony\Component\Serializer\Debug
View source 
class TraceableEncoder implements EncoderInterface, DecoderInterface, SerializerAwareInterface {
    public function __construct(EncoderInterface|DecoderInterface $encoder, SerializerDataCollector $dataCollector, string $serializerName = 'default') {
    }
    public function encode(mixed $data, string $format, array $context = []) : string {
        if (!$this->encoder instanceof EncoderInterface) {
            throw new \BadMethodCallException(\sprintf('The "%s()" method cannot be called as nested encoder doesn\'t implements "%s".', __METHOD__, EncoderInterface::class));
        }
        $startTime = microtime(true);
        $encoded = $this->encoder
            ->encode($data, $format, $context);
        $time = microtime(true) - $startTime;
        if ($traceId = $context[TraceableSerializer::DEBUG_TRACE_ID] ?? null) {
            $this->dataCollector
                ->collectEncoding($traceId, $this->encoder::class, $time, $this->serializerName);
        }
        return $encoded;
    }
    public function supportsEncoding(string $format, array $context = []) : bool {
        if (!$this->encoder instanceof EncoderInterface) {
            return false;
        }
        return $this->encoder
            ->supportsEncoding($format, $context);
    }
    public function decode(string $data, string $format, array $context = []) : mixed {
        if (!$this->encoder instanceof DecoderInterface) {
            throw new \BadMethodCallException(\sprintf('The "%s()" method cannot be called as nested encoder doesn\'t implements "%s".', __METHOD__, DecoderInterface::class));
        }
        $startTime = microtime(true);
        $encoded = $this->encoder
            ->decode($data, $format, $context);
        $time = microtime(true) - $startTime;
        if ($traceId = $context[TraceableSerializer::DEBUG_TRACE_ID] ?? null) {
            $this->dataCollector
                ->collectDecoding($traceId, $this->encoder::class, $time, $this->serializerName);
        }
        return $encoded;
    }
    public function supportsDecoding(string $format, array $context = []) : bool {
        if (!$this->encoder instanceof DecoderInterface) {
            return false;
        }
        return $this->encoder
            ->supportsDecoding($format, $context);
    }
    public function setSerializer(SerializerInterface $serializer) : void {
        if (!$this->encoder instanceof SerializerAwareInterface) {
            return;
        }
        $this->encoder
            ->setSerializer($serializer);
    }
    public function needsNormalization() : bool {
        return !$this->encoder instanceof NormalizationAwareInterface;
    }
    
    /**
     * Proxies all method calls to the original encoder.
     */
    public function __call(string $method, array $arguments) : mixed {
        return $this->encoder
            ->{$method}(...$arguments);
    }

}

Members

Title Modifiers Object type Summary Overriden Title
TraceableEncoder::decode public function Decodes a string into PHP data. Overrides DecoderInterface::decode
TraceableEncoder::encode public function Encodes data into the given format. Overrides EncoderInterface::encode
TraceableEncoder::needsNormalization public function
TraceableEncoder::setSerializer public function Sets the owning Serializer object. Overrides SerializerAwareInterface::setSerializer
TraceableEncoder::supportsDecoding public function Checks whether the deserializer can decode from given format. Overrides DecoderInterface::supportsDecoding
TraceableEncoder::supportsEncoding public function Checks whether the serializer can encode to given format. Overrides EncoderInterface::supportsEncoding
TraceableEncoder::__call public function Proxies all method calls to the original encoder.
TraceableEncoder::__construct public function