brettminnie/breakfast-serializer

Library for (de-)serializing data of any complexity to JSON

breakfast-serializer

, _(*1)

A replacement for the other well known serializer, initially we were aiming for backwards compatibility, however it seemed more appropriate to develop a lightweight alternative. We are forgoing the depth of features now to offer something that is easy to configure and works well without any configuration., _(*2)

Installation

$ composer require brettminnie/breakfast-serializer:0.1.*, _(*3)

Job done, start enjoying your morning serial!, _(*4)

Configuration

Out the box will do a full depth/breadth recursion and serialize to JSON format, no config is required. It will always serialize with a variable called className attached to the object. This is a fully fledged namespace and is required to deserialize. If you want to deserialize from JSON data that is missing this variable it needs to be injected into the object., _(*5)

Supported Serialization Formats

• [x] JSON
• [ ] XML
• [ ] PHP Object Notation
• [ ] YAML

Features

• [x] Simple limiting of traversal depth
• [x] Mapping of properties to alternate names and back again
• [x] Excluding of properties from serialization and ignoring them on deserialization
• [x] Simple YAML config format (Yay no slow php annotations!)

Quick and Dirty Example, _(*6)

    // To retrieve the json representation json of an object
    $jsonData = BDBStudios\BreakfastSerializer\SerializerFactory::getSerializer()
        ->serialize($myClass);

   // To unserialize
   $myClass = BDBStudios\BreakfastSerializer\SerializerFactory::getSerializer()
        ->deserialize($jsonData);

   //To serialize an object with a limited depth recursion (aka only some of it)
   $jsonData = 
      BDBStudios\BreakfastSerializer\SerializerFactory::getSerializer(
         BDBStudios\BreakfastSerializer\IsSerializable::FORMAT_JSON,
         2
      )
      ->serialize($myClass);

Further examples in the documentation directory., _(*7)