interface EncoderInterface

Defines the interface of encoders

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

Hierarchy

Expanded class hierarchy of EncoderInterface

All classes that implement EncoderInterface

5 files declare their use of EncoderInterface
ChainEncoder.php in drupal/core/vendor/symfony/serializer/Symfony/Component/Serializer/Encoder/ChainEncoder.php
JsonEncoder.php in drupal/core/modules/serialization/lib/Drupal/serialization/Encoder/JsonEncoder.php
Contains \Drupal\serialization\Encoder\JsonEncoder.
SerializationTestEncoder.php in drupal/core/modules/serialization/tests/serialization_test/lib/Drupal/serialization_test/SerializationTestEncoder.php
Contains \Drupal\serialization_test\SerializationTestEncoder.
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/EncoderInterface.php, line 19

Namespace

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

  /**
   * Encodes data into the given format
   *
   * @param mixed  $data   Data to encode
   * @param string $format Format name
   * @param array  $context options that normalizers/encoders have access to.
   *
   * @return scalar
   */
  public function encode($data, $format, array $context = array());

  /**
   * Checks whether the serializer can encode to given format
   *
   * @param string $format format name
   *
   * @return Boolean
   */
  public function supportsEncoding($format);

}

Members

Namesort descending Modifiers Type Description Overrides
EncoderInterface::encode public function Encodes data into the given format 7
EncoderInterface::supportsEncoding public function Checks whether the serializer can encode to given format 7