1Serializer 2========== 3 4.. image:: logo-small.png 5 6Introduction 7------------ 8This library allows you to (de-)serialize data of any complexity. Currently, it supports XML and JSON. 9 10It also provides you with a rich tool-set to adapt the output to your specific needs. 11 12Built-in features include: 13 14- (De-)serialize data of any complexity; circular references are handled gracefully. 15- Supports many built-in PHP types (such as dates) 16- Integrates with Doctrine ORM, et. al. 17- Supports versioning, e.g. for APIs 18- Configurable via XML, YAML, or Doctrine Annotations 19 20Installation 21------------ 22This library can be easily installed via composer 23 24.. code-block :: bash 25 26 composer require jms/serializer 27 28or just add it to your ``composer.json`` file directly. 29 30Usage 31----- 32For standalone projects usage of the provided builder is encouraged:: 33 34 $serializer = JMS\Serializer\SerializerBuilder::create()->build(); 35 $jsonContent = $serializer->serialize($data, 'json'); 36 echo $jsonContent; // or return it in a Response 37 38 39Documentation 40------------- 41 42.. toctree :: 43 :hidden: 44 45 configuration 46 usage 47 event_system 48 handlers 49 reference 50 cookbook 51 52- :doc:`Configuration <configuration>` 53- :doc:`Usage <usage>` 54- :doc:`Events <event_system>` 55- :doc:`Handlers <handlers>` 56 57- Recipes 58 * :doc:`/cookbook/exclusion_strategies` 59 60- Reference 61 * :doc:`Annotations </reference/annotations>` 62 * :doc:`XML Reference </reference/xml_reference>` 63 * :doc:`YML Reference </reference/yml_reference>` 64 65License 66------- 67 68The code is released under the business-friendly `MIT license`_. 69 70Documentation is subject to the `Attribution-NonCommercial-NoDerivs 3.0 Unported 71license`_. 72 73.. _MIT license: https://opensource.org/licenses/MIT 74.. _Attribution-NonCommercial-NoDerivs 3.0 Unported license: http://creativecommons.org/licenses/by-nc-nd/3.0/ 75 76