annotate core/lib/Drupal/Component/Serialization/SerializationInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Component\Serialization;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Defines an interface for serialization formats.
Chris@0 7 */
Chris@0 8 interface SerializationInterface {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * Encodes data into the serialization format.
Chris@0 12 *
Chris@0 13 * @param mixed $data
Chris@0 14 * The data to encode.
Chris@0 15 *
Chris@0 16 * @return string
Chris@0 17 * The encoded data.
Chris@0 18 */
Chris@0 19 public static function encode($data);
Chris@0 20
Chris@0 21 /**
Chris@0 22 * Decodes data from the serialization format.
Chris@0 23 *
Chris@0 24 * @param string $raw
Chris@0 25 * The raw data string to decode.
Chris@0 26 *
Chris@0 27 * @return mixed
Chris@0 28 * The decoded data.
Chris@0 29 */
Chris@0 30 public static function decode($raw);
Chris@0 31
Chris@0 32 /**
Chris@0 33 * Gets the file extension for this serialization format.
Chris@0 34 *
Chris@0 35 * @return string
Chris@0 36 * The file extension, without leading dot.
Chris@0 37 */
Chris@0 38 public static function getFileExtension();
Chris@0 39
Chris@0 40 }