interface DecoderInterface

Defines the interface of decoders

@author Jordi Boggiano <j.boggiano@seld.be>

Hierarchy

Expanded class hierarchy of DecoderInterface

All classes that implement DecoderInterface

3 files declare their use of DecoderInterface
ChainDecoder.php in drupal/core/vendor/symfony/serializer/Symfony/Component/Serializer/Encoder/ChainDecoder.php
Serializer.php in drupal/core/vendor/symfony/serializer/Symfony/Component/Serializer/Serializer.php
XmlEncoder.php in drupal/core/modules/serialization/lib/Drupal/serialization/Encoder/XmlEncoder.php
Contains \Drupal\serialization\Encoder\XmlEncoder.

File

drupal/core/vendor/symfony/serializer/Symfony/Component/Serializer/Encoder/DecoderInterface.php, line 19

Namespace

Symfony\Component\Serializer\Encoder
View source
interface DecoderInterface {

  /**
   * Decodes a string into PHP data.
   *
   * @param scalar $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
   */
  public function decode($data, $format, array $context = array());

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

}

Members

Namesort descending 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