Documented the useAttributeAsKey() method #5314
Conversation
|
|
||
| $rootNode | ||
| ->children() | ||
| ->arrayNode('parameters') |
There was a problem hiding this comment.
missing ->fixXmlConfig('parameter') before line 219
|
I think you got confused by the config tree :) Let's show some examples: Basic Prototyped Array (list)$node
->fixXmlConfig('driver')
->children()
->arrayNode('drivers')
->prototype('scalar')->end()
->end() // drivers
->end()
;drivers: ['mysql', 'sqlite']<driver>msyql</driver>
<driver>sqlite</driver>Output after processing: Array(
[0] => 'mysql'
[1] => 'sqlite'
)Prototyped Array With Children (list)$node
->fixXmlConfig('connection')
->children()
->arrayNode('connections')
->prototype('array')
->children()
->scalarNode('table')->end()
->scalarNode('user')->end()
->scalarNode('password')->end()
->end()
->end()
->end() // connections
->end()
;connections:
- { table: symfony, user: root, password: ~ }
- { table: foo, user: root, password: pa$$ }<connection table="symfony" user="root" password="null" />
<connection table="foo" user="root" password="pa$$" />Output after processing: Array(
[0] => Array(
[table] => 'symfony'
[user] => 'root'
[password] => null
)
[1] => Array(
[table] => 'foo'
[user] => 'root'
[password] => 'pa$$'
)
)Prototyped Array (list) With Wrong UsageAssume same tree as previous example, but now this yaml: connections:
sf_connection:
table: symfony
user: root
password: ~
default:
table: foo
user: root
password: pa$$The outcome will be exactly the same as the previous example, as the config component still handles Prototyped Array (map)Now, we can fix it using $node
->fixXmlConfig('connection')
->children()
->arrayNode('connections')
->prototype('array')
->useAttributeAsKey('name')
->children()
->scalarNode('table')->end()
->scalarNode('user')->end()
->scalarNode('password')->end()
->end()
->end()
->end() // connections
->end()
;Yaml is the same as previous example. <connection name="sf_connection"
table="symfony" user="root" password="null" />
<connection name="default"
table="foo" user="root" password="pa$$" />Output after processing: Array(
[sf_connection] => Array(
[table] => 'symfony'
[user] => 'root'
[password] => null
)
[default] => Array(
[table] => 'foo'
[user] => 'root'
[password] => 'pa$$'
)
) |
|
@wouterj thanks a lot for your excellent and insightful explanation. I've reused your exact same example to explain the method. Thanks! |
|
I wonder if we can label this PR as |
|
|
||
| The output configuration will be exactly the same as before. In other words, the | ||
| ``sf_connection`` and ``default`` configuration keys are lost. The reason is that | ||
| the Symfony Config component treats arrays as lists by default. |
There was a problem hiding this comment.
Is that actually true when using the YAML format? Isn't the useAttributeAsKey() method only necessary when using the XML format because XML itself does not know anything like hashes?
There was a problem hiding this comment.
@xabbuh actually, there is an inconsistency in Symfony currently: if we need to merge lists coming from multiple files, the keys are lost (merging them in a new list indexed numerically). However, in case merging is not necessary (a single file configures this list), we currently don't reset keys
|
@javiereguiluz please also document the |
| .. code-block:: yaml | ||
|
|
||
| drivers: ['mysql', 'sqlite'] | ||
|
|
There was a problem hiding this comment.
is this also possible?
drivers:
- mysql
- sqliteThere was a problem hiding this comment.
yes it is, because this is exactly the same in YAML, so the Config component receives the same input.
There was a problem hiding this comment.
ok, but we don't want to write this example explicitly, too?
There was a problem hiding this comment.
I see no need in doing that, this chapter is teaching you the Config component, not the Yaml syntax :)
|
@javiereguiluz do you maybe have time to finish this PR? |
This PR was merged into the 2.3 branch. Discussion ---------- Documented the useAttributeAsKey() method | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | all | Fixed tickets | #4509 Two comments: * I've reordered the list of methods (addDefaultsIfNotSet, requiresAtLeastOneElement, useAttributeAsKey) to display it alphabetically and because it's better to have `useAttributeAsKey` at the end, just before showing the example. * I've left the XML code blocks empty and I'd like some XML expert to help me fill them. Commits ------- 9fe9020 Fixed a minor syntax issue e77c3b2 Rewritten the explanation about the useAttributeAsKey() method 0f8f9fd Documented the useAttributeAsKey() method
|
Merged and continued in #5787 |
This PR was merged into the 2.3 branch. Discussion ---------- Definition Tweaks - see #5314 | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | n/a See #5314 - I am quite a novice with the Configuration component :). Commits ------- 51bc906 Fixes thanks to Stof 4e788e4 fixing build failure 67b8ff2 Tweaks - see #5314
* 2.3: changing includes to links Updating book examples to not use deprecated validation methods Updated constraint reference docs for Null->IsNull, False->IsFalse, True->IsTrue Creating placeholder constraint rst docs for deprecated usage Renaming constraint rst files to Is* to preserve edit history Fixes thanks to Stof fixing build failure Tweaks - see #5314
* 2.7: tweaks for 2.7 Fixing build error Tweaks thanks to everyone! [WIP] Reworking most of the registration form: Fixing build problems and wrong links changing includes to links Updating book examples to not use deprecated validation methods Updated constraint reference docs for Null->IsNull, False->IsFalse, True->IsTrue Creating placeholder constraint rst docs for deprecated usage Renaming constraint rst files to Is* to preserve edit history Fixes thanks to Stof fixing build failure Tweaks - see #5314
* 2.8: (29 commits) Removing getName() as it's not needed in 2.8 tweaks for 2.7 Fixing build error Tweaks thanks to everyone! [WIP] Reworking most of the registration form: Fixing build problems and wrong links Fixing build error Rename CollectionType entry options changing includes to links Updating book examples to not use deprecated validation methods Updated constraint reference docs for Null->IsNull, False->IsFalse, True->IsTrue Creating placeholder constraint rst docs for deprecated usage Renaming constraint rst files to Is* to preserve edit history Fixes thanks to Stof fixing build failure Tweaks - see #5314 Minor tweaks Final changes Reworded the introduction and other minor fixes Added a note about the advantages/drawbacks of listeners/subscribers ...
Two comments:
useAttributeAsKeyat the end, just before showing the example.