[DomCrawler] Add hint about Form::getName method #11705
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OskarStark
reviewed
Jun 9, 2019
41ed748 to
36ced8b
Compare
fabpot
added a commit
to symfony/symfony
that referenced
this pull request
Jun 14, 2019
…JustBlackBird) This PR was squashed before being merged into the 4.4 branch (closes #31959). Discussion ---------- [DomCrawler][Feature][DX] Add Form::getName() method | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | None | License | MIT | Doc PR | symfony/symfony-docs#11705 The PR adds `Symfony\Component\DomCrawler\Form::getName` method. The method is actually a syntax sugar but can improve DX when dealing with tests. For example, in the snippet ```php $client = static::createClient(); $crawler = $client->request('GET', '/post/hello-world'); $form = $crawler->selectButton('submit')->form(); $form['my_form[name]'] = 'Fabien'; $form['my_form[subject]'] = 'Symfony rocks!'; ``` the prefix in field name (`my_form`) is form name, which is generated by Symfony automatically. The method, added in the PR helps to get that name in a most obvious way. Commits ------- ff53cb4 [DomCrawler][Feature][DX] Add Form::getName() method
symfony-splitter
pushed a commit
to symfony/dom-crawler
that referenced
this pull request
Jun 14, 2019
…JustBlackBird) This PR was squashed before being merged into the 4.4 branch (closes #31959). Discussion ---------- [DomCrawler][Feature][DX] Add Form::getName() method | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | None | License | MIT | Doc PR | symfony/symfony-docs#11705 The PR adds `Symfony\Component\DomCrawler\Form::getName` method. The method is actually a syntax sugar but can improve DX when dealing with tests. For example, in the snippet ```php $client = static::createClient(); $crawler = $client->request('GET', '/post/hello-world'); $form = $crawler->selectButton('submit')->form(); $form['my_form[name]'] = 'Fabien'; $form['my_form[subject]'] = 'Symfony rocks!'; ``` the prefix in field name (`my_form`) is form name, which is generated by Symfony automatically. The method, added in the PR helps to get that name in a most obvious way. Commits ------- ff53cb462a [DomCrawler][Feature][DX] Add Form::getName() method
OskarStark
reviewed
Jun 14, 2019
testing.rst
Outdated
| @@ -801,6 +801,12 @@ their type:: | |||
| $form['my_form[field][O]']->upload('/path/to/lucas.jpg'); | |||
| $form['my_form[field][1]']->upload('/path/to/lisa.jpg'); | |||
|
|
|||
| .. tip:: | |||
|
|
|||
| All field names in forms generated by symfony are prefixed with form's name. | |||
There was a problem hiding this comment.
Suggested change
| All field names in forms generated by symfony are prefixed with form's name. | |
| All field names in forms generated by Symfony are prefixed with the form's name. |
There was a problem hiding this comment.
@OskarStark fixed
36ced8b to
c8a6ec5
Compare
xabbuh
reviewed
Jun 15, 2019
| .. tip:: | ||
|
|
||
| All field names in forms generated by Symfony are prefixed with the form's name. | ||
| If the name is autogenerated you can get it using |
There was a problem hiding this comment.
This sounds misleading IMO. For the method it doesn't really matter how the name originates. Maybe we should reword it to something like this:
Use the
getName()method if you need to access the name of a form.
There was a problem hiding this comment.
Name of the field is not that obvious on the first sight, so I believe a hint is needed to make it clear. Also, using getName method in tests can make them a little less fragile.
javiereguiluz
added a commit
that referenced
this pull request
Oct 1, 2019
…ackBird) This PR was merged into the 4.4 branch. Discussion ---------- [DomCrawler] Add hint about Form::getName method This PR describes some use cases of `Symfony\Component\DomCrawler\Form::getName` method Commits ------- c8a6ec5 [DomCrawler] Add hint about Form::getName method
|
Dmitriy, thanks a lot for contributing this nice little feature and thanks for providing the docs too! We merged it with some very minor rewords as proposed by @xabbuh. Congrats on your first Symfony Docs contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR describes some use cases of
Symfony\Component\DomCrawler\Form::getNamemethod