index.rst 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. JMSSerializerBundle
  2. ===================
  3. Introduction
  4. ------------
  5. JMSSerializerBundle allows you to serialize your objects into a requested
  6. output format such as JSON, XML, or YAML, and vice versa. It provides you
  7. with a rich toolset which empowers you to adapt the output to your specific
  8. needs.
  9. Built-in features include:
  10. - (de-)serialize object graphs of any complexity including circular references
  11. - supports many built-in PHP types (such as dates)
  12. - integrates with Doctrine ORM, et. al.
  13. - supports versioning, e.g. for APIs
  14. - configurable via PHP, XML, YAML, or annotations
  15. Documentation
  16. -------------
  17. .. toctree ::
  18. :hidden:
  19. installation
  20. configuration
  21. usage
  22. reference
  23. cookbook
  24. - :doc:`Installation <installation>`
  25. - :doc:`Configuration <configuration>`
  26. - :doc:`Usage <usage>`
  27. - Recipies
  28. * :doc:`Custom Handlers </cookbook/custom_handlers>`
  29. * :doc:`/cookbook/exclusion_strategies`
  30. * :doc:`/cookbook/metadata_for_third_party`
  31. - Reference
  32. * :doc:`Annotations </reference/annotations>`
  33. * :doc:`XML Reference </reference/xml_reference>`
  34. * :doc:`YML Reference </reference/yml_reference>`
  35. License
  36. -------
  37. The code is released under the business-friendly `Apache2 license`_.
  38. Documentation is subject to the `Attribution-NonCommercial-NoDerivs 3.0 Unported
  39. license`_.
  40. .. _Apache2 license: http://www.apache.org/licenses/LICENSE-2.0.html
  41. .. _Attribution-NonCommercial-NoDerivs 3.0 Unported license: http://creativecommons.org/licenses/by-nc-nd/3.0/