class ChainEncoder in Zircon Profile 8

Encoder delegating the decoding to a chain of encoders.

@author Jordi Boggiano <[e-mail]> @author Johannes M. Schmitt <[e-mail]> @author Lukas Kahwe Smith <[e-mail]>

Hierarchy

• class \Symfony\Component\Serializer\Encoder\ChainEncoder implements EncoderInterface

1 file declares its use of ChainEncoder

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

File

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

Namespace

Symfony\Component\Serializer\Encoder

class ChainEncoder implements EncoderInterface {
  protected $encoders = array();
  protected $encoderByFormat = array();
  public function __construct(array $encoders = array()) {
    $this->encoders = $encoders;
  }

  /**
   * {@inheritdoc}
   */
  public final function encode($data, $format, array $context = array()) {
    return $this
      ->getEncoder($format)
      ->encode($data, $format, $context);
  }

  /**
   * {@inheritdoc}
   */
  public function supportsEncoding($format) {
    try {
      $this
        ->getEncoder($format);
    } catch (RuntimeException $e) {
      return false;
    }
    return true;
  }

  /**
   * Checks whether the normalization is needed for the given format.
   *
   * @param string $format
   *
   * @return bool
   */
  public function needsNormalization($format) {
    $encoder = $this
      ->getEncoder($format);
    if (!$encoder instanceof NormalizationAwareInterface) {
      return true;
    }
    if ($encoder instanceof self) {
      return $encoder
        ->needsNormalization($format);
    }
    return false;
  }

  /**
   * Gets the encoder supporting the format.
   *
   * @param string $format
   *
   * @return EncoderInterface
   *
   * @throws RuntimeException if no encoder is found
   */
  private function getEncoder($format) {
    if (isset($this->encoderByFormat[$format]) && isset($this->encoders[$this->encoderByFormat[$format]])) {
      return $this->encoders[$this->encoderByFormat[$format]];
    }
    foreach ($this->encoders as $i => $encoder) {
      if ($encoder
        ->supportsEncoding($format)) {
        $this->encoderByFormat[$format] = $i;
        return $encoder;
      }
    }
    throw new RuntimeException(sprintf('No encoder found for format "%s".', $format));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ChainEncoder::$encoderByFormat	protected	property
ChainEncoder::$encoders	protected	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 EncoderInterface::supportsEncoding
ChainEncoder::__construct	public	function