Advanced YAML component usage #6582
Conversation
|
Thanks, this closes #6524. |
| $dumper->dump($data, 2, 4, true); | ||
|
|
||
| // throw an exception if an encoded object is found in the YAML string | ||
| $parser->parse($yaml, true); // throw an exception |
There was a problem hiding this comment.
remove duplicated throw an exceptiong
|
|
|
Also |
| By default the YAML component will use 4 spaces for indentation, this can be | ||
| changed using the second argument as follows: | ||
|
|
||
| .. code-block:: php |
There was a problem hiding this comment.
please use the :: shortcut here (meaning the colon on line 229 should be changed to a double one and line 230 and 231 should be removed)
|
I like this one, it's straight to the point and clear. Thanks! |
|
Updated. As noted above 2.5 introduced a new argument. Shall I wait until this is resolved / merged before making a PR on 2.5, and then finally on 3.1 ? |
| $yaml = Yaml::dump($array); | ||
|
|
||
| Array Expansion and Inlining | ||
| """""""""""""""""""""""""""" |
There was a problem hiding this comment.
We usually use dots (.) for the 4th headline level.
|
@dantleech 2.5 is not maintained anymore, so I suggest you wait for this to be merged on 2.7 to send another PR. You will need to add a note version added where you can point 2.5. |
| Indentation | ||
| """"""""""" | ||
|
|
||
| By default the YAML component will use 4 spaces for indentation, this can be |
There was a problem hiding this comment.
I would split this in two sentences: "[...] for indentation. This can be [...]"
|
@dantleech you can already create a PR for 2.7 and then rebase after this PR is merged. That allows us to review things already so merging will be a quick process. |
|
Updated. |
| type is encountered in either the dumper or parser as follows:: | ||
|
|
||
| // throw an exception if a resource or object is encoutered | ||
| $dumper->dump($data, 2, 4, true); |
There was a problem hiding this comment.
The reason I used the dumper is because it was already used in the Writing YAML files section more than once. Assuming now that after we declare the shortcut we should continue using the shortcut.
|
Just left some last minor comments, but overall this looks quite great! |
dantleech
force-pushed
the
advanced_yaml
branch
2 times, most recently
from
8917c91 to
f192d5b
Compare
|
Updated |
|
I just noticed that the chapter contains this sentence:
What do we do with it? Remove it? |
| Instead of encoding as ``null`` you can choose to throw an exception if an invalid | ||
| type is encountered in either the dumper or parser as follows:: | ||
|
|
||
| // throw an exception if a resource or object is encoutered |
Hmm. Either we remove that or the new documentation, or we add a warning. |
|
My suggestion: Let's remove the existing one and add a warning in the new section telling people that object support is a feature only existing in the Symfony Yaml component and thus (as not being part of the standard) very likely not supported in other implementations. |
|
@xabbuh I'd say remove it. The code display show a clear warning when trying to dump resources, so the docs can safely ignore this edge case. |
|
Removed the previous |
|
👍 |
| ........... | ||
|
|
||
| By default the YAML component will use 4 spaces for indentation. This can be | ||
| changed using the second argument as follows:: |
There was a problem hiding this comment.
the second argument -> the third argument ?
|
|
||
| .. warning:: | ||
|
|
||
| Object seialization is specific to this implementation, other PHP YAML |
This PR was merged into the 2.3 branch. Discussion ---------- Advanced YAML component usage | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | 2.3 > 3.0 (i think) | Fixed tickets | #6524 Prerequisite to #6226 This PR documents the (now deprecated) features for indentation, invalid types and object serialization which have been present since sf 2.3 Commits ------- 3249cbb Advanced YAML component usage
|
Thanks @dantleech! This is now merged into all branches of the docs, so you can start working on the dumper flags if yo uwant. |
This PR was submitted for the master branch but it was merged into the 2.7 branch instead (closes #6590). Discussion ---------- Added note on YAML mappings as objects | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | 2.7 > 3.0 Depends on #6582 Commits ------- e9de4ca Added note on YAML mappings as objects
Prerequisite to #6226
This PR documents the (now deprecated) features for indentation, invalid types and object serialization which have been present since sf 2.3