aleph1.co.uk Git - yaffs-website/blob - serializer/Normalizer/DenormalizableInterface.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\Serializer\Normalizer;
  13
  14 /**
  15  * Defines the most basic interface a class must implement to be denormalizable.
  16  *
  17  * If a denormalizer is registered for the class and it doesn't implement
  18  * the Denormalizable interfaces, the normalizer will be used instead
  19  *
  20  * @author Jordi Boggiano <j.boggiano@seld.be>
  21  */
  22 interface DenormalizableInterface
  23 {
  24     /**
  25      * Denormalizes the object back from an array of scalars|arrays.
  26      *
  27      * It is important to understand that the denormalize() call should denormalize
  28      * recursively all child objects of the implementor.
  29      *
  30      * @param DenormalizerInterface       $denormalizer The denormalizer is given so that you
  31      *                                                  can use it to denormalize objects contained within this object
  32      * @param array|string|int|float|bool $data         The data from which to re-create the object
  33      * @param string|null                 $format       The format is optionally given to be able to denormalize
  34      *                                                  differently based on different input formats
  35      * @param array                       $context      Options for denormalizing
  36      *
  37      * @return object
  38      */
  39     public function denormalize(DenormalizerInterface $denormalizer, $data, $format = null, array $context = array());
  40 }