Skip to content

[Twig] [twig reference] add examples in yaml part #19640

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 23, 2024
Merged

[Twig] [twig reference] add examples in yaml part #19640

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
73 changes: 71 additions & 2 deletions reference/twig_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,8 +483,43 @@ yaml_encode
``dumpObjects`` *(optional)*
**type**: ``boolean`` **default**: ``false``

Transforms the input into YAML syntax. See :ref:`components-yaml-dump` for
more information.
Transforms the input into YAML syntax.

The ``inline`` argument is the level where you switch to inline YAML:

.. code-block:: twig

{% set array = {
'a': {
'c': 'e'
},
'b': {
'd': 'f'
}
} %}

{{ array|yaml_encode(inline = 0) }}
{# output: { a: { c: e }, b: { d: f } } #}

{{ array|yaml_encode(inline = 1) }}
{# output: a: { c: e } b: { d: f } #}
Copy link
Member

Choose a reason for hiding this comment

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

This looks wrong to me. The top-level mapping needs to span multiple-lines if it doesn't use the inline syntax.

Copy link
Member

Choose a reason for hiding this comment

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

I fixed this while merging. See 56d0815 I opted for always showing the output in a new line because otherwise is very confusing for output that generates more than 1 line.


The ``dumpObjects`` argument is used to dump objects::

// ...
$object = new \stdClass();
$object->foo = 'bar';
// ...

.. code-block:: twig

{{ object|yaml_encode(dumpObjects = false) }}
{# output: null #}

{{ object|yaml_encode(dumpObjects = true) }}
{# output: !php/object 'O:8:"stdClass":1:{s:5:"foo";s:7:"bar";}' #}

See :ref:`components-yaml-dump` for more information.

yaml_dump
~~~~~~~~~
Expand All @@ -503,6 +538,40 @@ yaml_dump
Does the same as `yaml_encode() <yaml_encode>`_, but includes the type in
the output.

The ``inline`` argument is the level where you switch to inline YAML:

.. code-block:: twig

{% set array = {
'a': {
'c': 'e'
},
'b': {
'd': 'f'
}
} %}

{{ array|yaml_dump(inline = 0) }}
{# output: %array% { a: { c: e }, b: { d: f } } #}

{{ array|yaml_dump(inline = 1) }}
{# output: %array% a: { c: e } b: { d: f } #}
Copy link
Member

Choose a reason for hiding this comment

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

see my comment above for yaml_encode


The ``dumpObjects`` argument is used to dump objects::

// ...
$object = new \stdClass();
$object->foo = 'bar';
// ...

.. code-block:: twig

{{ object|yaml_dump(dumpObjects = false) }}
{# output: %object% null #}

{{ object|yaml_dump(dumpObjects = true) }}
{# output: %object% !php/object 'O:8:"stdClass":1:{s:3:"foo";s:3:"bar";}' #}

abbr_class
~~~~~~~~~~

Expand Down
Loading