interface DecoderInterface in Zircon Profile 8

Defines the interface of decoders.

@author Jordi Boggiano <[e-mail]>

Hierarchy

• interface \Symfony\Component\Serializer\Encoder\DecoderInterface

3 files declare their use of DecoderInterface

JsonEncoder.php in core/modules/serialization/src/Encoder/JsonEncoder.php

Contains \Drupal\serialization\Encoder\JsonEncoder.

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

XmlEncoder.php in core/modules/serialization/src/Encoder/XmlEncoder.php

Contains \Drupal\serialization\Encoder\XmlEncoder.

File

vendor/symfony/serializer/Encoder/DecoderInterface.php, line 21

Namespace

Symfony\Component\Serializer\Encoder

interface DecoderInterface {

  /**
   * Decodes a string into PHP data.
   *
   * @param string $data    Data to decode
   * @param string $format  Format name
   * @param array  $context options that decoders have access to.
   *
   * The format parameter specifies which format the data is in; valid values
   * depend on the specific implementation. Authors implementing this interface
   * are encouraged to document which formats they support in a non-inherited
   * phpdoc comment.
   *
   * @return mixed
   *
   * @throws UnexpectedValueException
   */
  public function decode($data, $format, array $context = array());

  /**
   * Checks whether the deserializer can decode from given format.
   *
   * @param string $format format name
   *
   * @return bool
   */
  public function supportsDecoding($format);

}

Members

Name	Modifiers	Type	Description	Overrides
DecoderInterface::decode	public	function	Decodes a string into PHP data.	6
DecoderInterface::supportsDecoding	public	function	Checks whether the deserializer can decode from given format.	6