class ChainEncoder

Encoder delegating the decoding to a chain of encoders.

@author Jordi Boggiano <j.boggiano@seld.be> @author Johannes M. Schmitt <schmittjoh@gmail.com> @author Lukas Kahwe Smith <smith@pooteeweet.org>

@final

Hierarchy

class \Symfony\Component\Serializer\Encoder\ChainEncoder implements \Symfony\Component\Serializer\Encoder\ContextAwareEncoderInterface

Expanded class hierarchy of ChainEncoder

1 file declares its use of ChainEncoder

Serializer.php in vendor/symfony/serializer/Serializer.php

File

vendor/symfony/serializer/Encoder/ChainEncoder.php, line 26

Namespace

Symfony\Component\Serializer\Encoder

View source

class ChainEncoder implements ContextAwareEncoderInterface {
    
    /**
     * @var array<string, array-key>
     */
    private array $encoderByFormat = [];
    
    /**
     * @param array<EncoderInterface> $encoders
     */
    public function __construct(array $encoders = []) {
    }
    public final function encode(mixed $data, string $format, array $context = []) : string {
        return $this->getEncoder($format, $context)
            ->encode($data, $format, $context);
    }
    public function supportsEncoding(string $format, array $context = []) : bool {
        try {
            $this->getEncoder($format, $context);
        } catch (RuntimeException) {
            return false;
        }
        return true;
    }
    
    /**
     * Checks whether the normalization is needed for the given format.
     */
    public function needsNormalization(string $format, array $context = []) : bool {
        $encoder = $this->getEncoder($format, $context);
        if ($encoder instanceof TraceableEncoder) {
            return $encoder->needsNormalization();
        }
        if (!$encoder instanceof NormalizationAwareInterface) {
            return true;
        }
        if ($encoder instanceof self) {
            return $encoder->needsNormalization($format, $context);
        }
        return false;
    }
    
    /**
     * Gets the encoder supporting the format.
     *
     * @throws RuntimeException if no encoder is found
     */
    private function getEncoder(string $format, array $context) : EncoderInterface {
        if (isset($this->encoderByFormat[$format]) && isset($this->encoders[$this->encoderByFormat[$format]])) {
            return $this->encoders[$this->encoderByFormat[$format]];
        }
        $cache = true;
        foreach ($this->encoders as $i => $encoder) {
            $cache = $cache && !$encoder instanceof ContextAwareEncoderInterface;
            if ($encoder->supportsEncoding($format, $context)) {
                if ($cache) {
                    $this->encoderByFormat[$format] = $i;
                }
                return $encoder;
            }
        }
        throw new RuntimeException(\sprintf('No encoder found for format "%s".', $format));
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title
ChainEncoder::$encoderByFormat	private	property
ChainEncoder::encode	final public	function	Encodes data into the given format.	Overrides EncoderInterface::encode
ChainEncoder::getEncoder	private	function	Gets the encoder supporting the format.
ChainEncoder::needsNormalization	public	function	Checks whether the normalization is needed for the given format.
ChainEncoder::supportsEncoding	public	function	Checks whether the serializer can encode to given format.	Overrides ContextAwareEncoderInterface::supportsEncoding
ChainEncoder::__construct	public	function