Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

[Serializer] Document the encoders#6684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
weaverryan merged 1 commit intosymfony:2.7fromGuilhemN:ENCODERS
Sep 18, 2016
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletioncomponents/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ The Components
property_access/index
routing/index
security/index
serializer
serializer/index
stopwatch
templating/index
translation/index
Expand Down
5 changes: 3 additions & 2 deletionscomponents/map.rst.inc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -140,9 +140,10 @@
* :doc:`/components/security/authorization`
* :doc:`/components/security/secure_tools`

***Serializer**
*:doc:`/components/serializer/index`

* :doc:`/components/serializer`
* :doc:`/components/serializer/introduction`
* :doc:`/components/serializer/encoders`

***Stopwatch**

Expand Down
63 changes: 63 additions & 0 deletionscomponents/serializer/encoders.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
.. index::
single: Serializer, Encoders

Encoders
========

Encoders basically turn **arrays** into **formats** and vice versa.
They implement
:class:`Symfony\\Component\\Serializer\\Encoder\\EncoderInterface` for
encoding (array to format) and
:class:`Symfony\\Component\\Serializer\\Encoder\\DecoderInterface` for
decoding (format to array).

You can add new encoders to a Serializer instance by using its second constructor argument::

use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Serializer\Encoder\XmlEncoder;
use Symfony\Component\Serializer\Encoder\JsonEncoder;

$encoders = array(new XmlEncoder(), new JsonEncoder());
$serializer = new Serializer(array(), $encoders);

Built-in Encoders
-----------------

Two encoders are used in the example above:

* :class:`Symfony\\Component\\Serializer\\Encoder\\XmlEncoder` to encode/decode XML
* :class:`Symfony\\Component\\Serializer\\Encoder\\JsonEncoder` to encode/decode JSON

The ``XmlEncoder``
~~~~~~~~~~~~~~~~~~

This encoder transforms arrays into XML and vice versa.

For example, take an object normalized as following::

array('foo' => array(1, 2), 'bar' => true);

The ``XmlEncoder`` will encode this object like that::

<?xml version="1.0"?>
<response>
<foo>1</foo>
<foo>2</foo>
<bar>1</bar>
</response>

Be aware that this encoder will consider keys beginning with ``@`` as attributes::

$encoder = new XmlEncoder();
$encoder->encode(array('foo' => array('@bar' => 'value')));
// will return:
// <?xml version="1.0"?>
// <response>
// <foo bar="value" />
// </response>

The ``JsonEncoder``
~~~~~~~~~~~~~~~~~~~

The ``JsonEncoder`` is much simpler and is based on the PHP
:phpfunction:`json_encode` and :phpfunction:`json_decode` functions.
8 changes: 8 additions & 0 deletionscomponents/serializer/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Serializer
==========

..toctree::
:maxdepth:2

introduction
encoders
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ Usage

Using the Serializer component is really simple. You just need to set up
the:class:`Symfony\\Component\\Serializer\\Serializer` specifying
whichEncoders andNormalizer are going to be available::
whichencoders andnormalizers are going to be available::

use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Serializer\Encoder\XmlEncoder;
Expand All@@ -57,10 +57,14 @@ which Encoders and Normalizer are going to be available::
$serializer = new Serializer($normalizers, $encoders);

The preferred normalizer is the
:class:`Symfony\\Component\\Serializer\\Normalizer\\ObjectNormalizer`, but other
normalizers are available.
To read more about them, refer to the `Normalizers`_ section of this page. All
the examples shown below use the ``ObjectNormalizer``.
:class:`Symfony\\Component\\Serializer\\Normalizer\\ObjectNormalizer`,
but other normalizers are available. All the examples shown below use
the ``ObjectNormalizer``.

..seealso::

Read the dedicated sections to learn more about:doc:`/components/serializer/encoders`
and `Normalizers`_.

Serializing an Object
---------------------
Expand Down
2 changes: 1 addition & 1 deletioncookbook/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ The Cookbook
request/index
routing/index
security/index
serializer
serializer/index
service_container/index
session/index
symfony1
Expand Down
5 changes: 3 additions & 2 deletionscookbook/map.rst.inc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -187,9 +187,10 @@
* :doc:`/cookbook/security/securing_services`
* :doc:`/cookbook/security/access_control`

***Serializer**
*:doc:`/cookbook/serializer/index`

* :doc:`/cookbook/serializer`
* :doc:`/cookbook/serializer/introduction`
Copy link
ContributorAuthor

@GuilhemNGuilhemNJul 18, 2016•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I'm not sure about this name, if someone has a better idea...

* :doc:`/cookbook/serializer/custom_encoders`

* :doc:`/cookbook/service_container/index`

Expand Down
97 changes: 97 additions & 0 deletionscookbook/serializer/custom_encoders.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
.. index::
single: Serializer; Custom encoders

How to Create your Custom Encoder
=================================

The :doc:`Serializer Component </components/serializer/index>` uses Normalizers
to transform any data to an array that can be then converted in whatever
data-structured language you want thanks to Encoders.

The Component provides several built-in encoders that are described
:doc:`in their own section </components/serializer/encoders>` but you may want
to use another language not supported.

Creating a new encoder
----------------------

Imagine you want to serialize and deserialize Yaml. For that you'll have to
create your own encoder that may use the
:doc:`Yaml Component </components/yaml/index>`::

namespace AppBundle\Encoder;

use Symfony\Component\Serializer\Encoder\DecoderInterface;
use Symfony\Component\Serializer\Encoder\EncoderInterface;
use Symfony\Component\Yaml\Yaml;

class YamlEncoder implements EncoderInterface, DecoderInterface
{
public function encode($data, $format, array $context = array())
{
return Yaml::dump($data);
}

public function supportsEncoding($format)
{
return 'yaml' === $format;
}

public function decode($data, $format, array $context = array())
{
return Yaml::parse($data);
}

public function supportsDecoding($format)
{
return 'yaml' === $format;
}
}

Registering it in your app
--------------------------

If you use the Symfony Framework then you probably want to register this encoder
as a service in your app. Then you only need to tag it as `serializer.encoder` and it will be
injected in the Serializer.

.. configuration-block::

.. code-block:: yaml

# app/config/services.yml
services:
app.encoder.yaml:
class: AppBundle\Encoder\YamlEncoder
tags:
- { name: serializer.encoder }

.. code-block:: xml

<!-- app/config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">

<services>
<service id="app.encoder.yaml" class="AppBundle\Encoder\YamlEncoder">
<tag name="serializer.encoder" />
</service>
</services>
</container>

.. code-block:: php

// app/config/services.php
$container
->register(
'app.encoder.yaml',
'AppBundle\Encoder\YamlEncoder'
)
->addTag('serializer.encoder')
;

Now you'll be able to serialize and deserialize Yaml!

.. _tracker: https://github.com/symfony/symfony/issues
8 changes: 8 additions & 0 deletionscookbook/serializer/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
Serializer
==========

.. toctree::
:maxdepth: 2

introduction
custom_encoders
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
.. index::
single: Serializer
single: Serializer; Introduction

How to Use the Serializer
=========================

Serializing and deserializing to and from objects and different formats (e.g.
JSON or XML) is a very complex topic. Symfony comes with a
:doc:`Serializer Component </components/serializer>`, which gives you some
:doc:`Serializer Component </components/serializer/index>`, which gives you some
tools that you can leverage for your solution.

In fact, before you start, get familiar with the serializer, normalizers
and encoders by reading the :doc:`Serializer Component </components/serializer>`.
and encoders by reading the :doc:`Serializer Component </components/serializer/index>`.

Activating the Serializer
-------------------------
Expand Down
2 changes: 2 additions & 0 deletionsredirection_map
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
/cookbook/email /cookbook/email/email
/cookbook/gmail /cookbook/email/gmail
/cookbook/console /components/console
/cookbook/serializer /cookbook/serializer/introduction
/cookbook/tools/autoloader /components/class_loader
/cookbook/tools/finder /components/finder
/cookbook/service_container/parentservices /components/dependency_injection/parentservices
Expand All@@ -26,6 +27,7 @@
/components/yaml /components/yaml/introduction
/components/templating /components/templating/introduction
/components/filesystem /components/filesystem/introduction
/components/serializer /components/serializer/introduction
/cmf/reference/configuration/block /cmf/bundles/block/configuration
/cmf/reference/configuration/content /cmf/bundles/content/configuration
/cmf/reference/configuration/core /cmf/bundles/core/configuration
Expand Down
4 changes: 2 additions & 2 deletionsreference/dic_tags.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -946,7 +946,7 @@ serializer.encoder
The class that's tagged should implement the :class:`Symfony\\Component\\Serializer\\Encoder\\EncoderInterface`
and :class:`Symfony\\Component\\Serializer\\Encoder\\DecoderInterface`.

For more details, see :doc:`/cookbook/serializer`.
For more details, see :doc:`/cookbook/serializer/introduction`.

.. _reference-dic-tags-serializer-normalizer:

Expand All@@ -958,7 +958,7 @@ serializer.normalizer
The class that's tagged should implement the :class:`Symfony\\Component\\Serializer\\Normalizer\\NormalizerInterface`
and :class:`Symfony\\Component\\Serializer\\Normalizer\\DenormalizerInterface`.

For more details, see :doc:`/cookbook/serializer`.
For more details, see :doc:`/cookbook/serializer/introduction`.

swiftmailer.default.plugin
--------------------------
Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp