Documentation for YAML flags added in 3.1 #6622

dantleech · 2016-05-27T10:25:09Z

Following on from #6590 this PR documents the YAML flags introduced in Symfony 3.1

dantleech · 2016-05-27T10:26:19Z

components/yaml/introduction.rst

-Invalid Types and Object Serialization
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Advanced Usage: Flags
+---------------------



I thought about adding a table here with the flag, which method it applies to (linking to a section below) and a short description.

javiereguiluz · 2016-05-27T13:13:22Z

I've left some comments but this looks really nice. Thank you @dantleech.

dantleech · 2016-05-27T14:09:42Z

Updated.

wouterj · 2016-05-27T17:21:46Z

components/yaml/introduction.rst

@@ -250,6 +233,77 @@ representation of the object.
    parsers will likely not recognize the ``php/object`` tag and non-PHP
    implementations certainly won't - use with discretion!

+Handling Invalid Types


before this headline, we should add a line: .. _invalid-types-and-object-serialization: This way, all section links still work across versions.

Well spotted

xabbuh · 2016-05-29T11:40:55Z

components/yaml/introduction.rst

@@ -127,20 +127,6 @@ error occurred:

 .. _components-yaml-dump:

-Objects for Mappings


We should add a label to the new headline for existing deep links to the section (like you already have done it for the "Invalid Types and Object Serialization" headline).

Added an additional .. _objects-for-mappings is that what you meant?

Yes, but wouldn't that better fit just above the "Using Objects for Maps" headline?

dantleech · 2016-05-31T07:27:33Z

Don't know why platform sh failed - it seems to have gone away now,

Also I don't seem to be able to build the docs locally as $ git submodule update --init doesn't seem to do anything.

xabbuh · 2016-06-06T06:03:22Z

components/yaml/introduction.rst

+Handling Invalid Types
+~~~~~~~~~~~~~~~~~~~~~~
+
+By default the parser will encode invalid types as "null". You can make the


I would enclose null with double backticks instead of quotes.

HeahDude · 2016-06-26T12:36:58Z

@dantleech Can you please rebase, it seems there are some conflicts. Thanks!

dantleech · 2016-06-26T12:47:13Z

Rebased

On Sun, Jun 26, 2016 at 05:37:00AM -0700, Jules Pietri wrote:

[1]@dantleech Can you please rebase, it seems there are some conflicts.
Thanks!

—
You are receiving this because you were mentioned.
Reply to this email directly, [2]view it on GitHub, or [3]mute the thread.

Reverse link: [4]unknown

References

Visible links

https://github.com/dantleech

Documentation for YAML flags added in 3.1 #6622 (comment)

https://github.com/notifications/unsubscribe/AAgZcQoWdHyH1k4cVymTyLdMBx9-BIRnks5qPnJsgaJpZM4IoXrx

Documentation for YAML flags added in 3.1 #6622 (comment)

HeahDude · 2016-06-26T12:54:46Z

Looks good, thanks!

Status: Needs Review

HeahDude · 2016-06-27T14:59:07Z

components/yaml/introduction.rst

+    $data = new \stdClass(); // by default objects are invalid.
+    Yaml::parse($data, Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE); // throws an exception
+
+.. _objects-for-mappings:


This looks like a wrong place, should be up before Object Parsing and Dumping subtitle, right?

stof · 2016-06-27T15:46:26Z

components/yaml/introduction.rst

+
+    $date = Yaml::parse('2016-05-27', Yaml::PARSE_DATETIME);
+    var_dump(get_class($date)); // DateTime
+


I would add a note saying that the dumper accepts DateTime (and DateTimeImmutable) objects since 3.1 as well, to dump them as YAML timestamps, without the need for any flag

This PR was merged into the 3.1 branch. Discussion ---------- Documentation for YAML flags added in 3.1 Following on from #6590 this PR documents the YAML flags introduced in Symfony 3.1 Commits ------- 3895fc9 Documentation for YAML flags added in 3.1

weaverryan · 2016-09-17T18:44:24Z

components/yaml/introduction.rst

+Similarly you can use ``DUMP_EXCEPTION_ON_INVALID_TYPE`` when dumping::
+
+    $data = new \stdClass(); // by default objects are invalid.
+    Yaml::parse($data, Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE); // throws an exception


this should have been dump(), right? I'm making that change now...

dantleech reviewed May 27, 2016
View reviewed changes

dantleech force-pushed the yaml_3_1 branch 3 times, most recently from ee4b701 to d682ede Compare May 27, 2016 14:08

wouterj reviewed May 27, 2016
View reviewed changes

wouterj added the Status: Needs Work label May 27, 2016

dantleech force-pushed the yaml_3_1 branch from d682ede to 7691c59 Compare May 28, 2016 09:18

xabbuh reviewed May 29, 2016
View reviewed changes

dantleech force-pushed the yaml_3_1 branch from 7691c59 to 2d8680c Compare May 31, 2016 07:25

xabbuh reviewed Jun 6, 2016
View reviewed changes

dantleech force-pushed the yaml_3_1 branch from 2d8680c to 2bb32cf Compare June 26, 2016 12:46

dantleech force-pushed the yaml_3_1 branch from 2bb32cf to 9cc982f Compare June 26, 2016 12:49

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jun 26, 2016

HeahDude reviewed Jun 27, 2016
View reviewed changes

Documentation for YAML flags added in 3.1

3895fc9

dantleech force-pushed the yaml_3_1 branch from 9cc982f to 3895fc9 Compare June 27, 2016 15:33

stof reviewed Jun 27, 2016
View reviewed changes

weaverryan merged commit 3895fc9 into symfony:3.1 Sep 17, 2016

weaverryan reviewed Sep 17, 2016

View reviewed changes

weaverryan added a commit that referenced this pull request Sep 17, 2016

[#6622] Fixing bad placement of anchor

20b3b37

weaverryan added a commit that referenced this pull request Sep 17, 2016

[#6622] Changing line from parse() to dump()

f2e2914

xabbuh mentioned this pull request Sep 21, 2016

Yaml: Removed boolean flags #6950

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation for YAML flags added in 3.1 #6622

Documentation for YAML flags added in 3.1 #6622

dantleech commented May 27, 2016

dantleech May 27, 2016

javiereguiluz commented May 27, 2016

dantleech commented May 27, 2016

wouterj May 27, 2016

dantleech May 28, 2016

xabbuh May 29, 2016

dantleech May 31, 2016 •

edited

Loading

xabbuh Jun 6, 2016

dantleech Jun 26, 2016

dantleech commented May 31, 2016

xabbuh Jun 6, 2016

HeahDude commented Jun 26, 2016

dantleech commented Jun 26, 2016

HeahDude commented Jun 26, 2016

HeahDude Jun 27, 2016

stof Jun 27, 2016

weaverryan Sep 17, 2016

		@@ -127,20 +127,6 @@ error occurred:

		.. _components-yaml-dump:

		Objects for Mappings


		$date = Yaml::parse('2016-05-27', Yaml::PARSE_DATETIME);
		var_dump(get_class($date)); // DateTime

Documentation for YAML flags added in 3.1 #6622

Documentation for YAML flags added in 3.1 #6622

Conversation

dantleech commented May 27, 2016

Choose a reason for hiding this comment

javiereguiluz commented May 27, 2016

dantleech commented May 27, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dantleech May 31, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dantleech commented May 31, 2016

Choose a reason for hiding this comment

HeahDude commented Jun 26, 2016

dantleech commented Jun 26, 2016

HeahDude commented Jun 26, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dantleech May 31, 2016 •

edited

Loading