Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory :  /home/corals/mautic.corals.io/vendor/jms/serializer-bundle/Resources/doc/

Upload File : current_dir [ Writeable ] document_root [ Writeable ]

JMSSerializerBundle
===================

Introduction
------------
JMSSerializerBundle allows you to serialize your data into a requested
output format such as JSON, XML, or YAML, and vice versa.

You can learn more in the `documentation <http://jmsyst.com/libs/serializer>`_ for the standalone library.

Installation
------------
You can install this bundle using composer

.. code-block :: bash

    composer require jms/serializer-bundle

or add the package to your ``composer.json`` file directly.

After you have installed the package, you just need to add the bundle to your ``AppKernel.php`` file::

    // in AppKernel::registerBundles()
    $bundles = array(
        // ...
        new JMS\SerializerBundle\JMSSerializerBundle(),
        // ...
    );

Configuration
-------------
JMSSerializerBundle requires no initial configuration to get you started.

For all available configuration options, please see the :doc:`configuration reference <configuration>`.

Usage
-----
The configured serializer is available as ``jms_serializer`` (or ``jms_serializer.instances.default``) service::

    $serializer = $container->get('jms_serializer');
    $serializer->serialize($data, $format);
    $data = $serializer->deserialize($inputStr, $typeName, $format);

In templates, you may also use the ``serialize`` filter:

.. code-block :: html+jinja

    {{ data | jms_serialize }} {# serializes to JSON #}
    {{ data | jms_serialize('json') }}
    {{ data | jms_serialize('xml') }}

Learn more in the `documentation for the dedicated library <http://jmsyst.com/libs/serializer/master/usage>`_.

License
-------

The code is released under the `MIT license`_.

Documentation is subject to the `Attribution-NonCommercial-NoDerivs 3.0 Unported
license`_.

.. _MIT license: https://opensource.org/licenses/MIT
.. _Attribution-NonCommercial-NoDerivs 3.0 Unported license: http://creativecommons.org/licenses/by-nc-nd/3.0/