[BrowserKit] Rename Client to Browser #30541
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
b5151a7 to
3a84669
Compare
nicolas-grekas
approved these changes
Mar 12, 2019
fabpot
added a commit
that referenced
this pull request
Mar 12, 2019
This PR was merged into the 4.3-dev branch. Discussion ---------- [BrowserKit] Rename Client to Browser | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | yes | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | n/a | License | MIT | Doc PR | n/a `Client` is very generic and used in 3 places: BrowserKit, HttpKernel, and FramewrokBundle. Each Client extends another one. So, to make things clearer, I'd like to rename Client to Browser like this: Symfony\Component\BrowerKit\Client -> AbstractBrowser Symfony\Component\HttpKernel\Client -> HttpKernelBrowser Symfony\Bundle\FrameworkBundle\Client -> KernelBrowser The next PR will introduce an `HttpBrowser` based on the new HttpClient component :) Commits ------- dbe4f86 renamed Client to Browser
stof
reviewed
Mar 13, 2019
| * | ||
| * @param array $options An array of options to pass to the createKernel method | ||
| * @param array $server An array of server parameters | ||
| * | ||
| * @return Client A Client instance | ||
| * @return KernelBrowser A KernelBrowser instance | ||
| */ | ||
| protected static function createClient(array $options = [], array $server = []) |
There was a problem hiding this comment.
should we rename that method too ?
There was a problem hiding this comment.
I thought about renaming methods but I think that's too much. What others think?
There was a problem hiding this comment.
With a hard copy pasting you could also add return type hints on methods.
|
This is a BC break, because the BC class |
|
I think you will need to use class aliases here instead., to preserve the class hierarchy. |
|
Yes, it breaks at least https://github.com/FriendsOfBehat/SymfonyExtension and https://github.com/minkphp/MinkBrowserKitDriver. For now people can workaround it by adding the following to their test bootstrap: This should be near the top, as it will only work when the class has not yet been autoloaded. |
|
@Devristo Can you create a new issue... and if you can provide a PR, that would be wonderful :) |
This was referenced Apr 9, 2019
fabpot
added a commit
that referenced
this pull request
Apr 15, 2019
… to Browser (Devristo) This PR was squashed before being merged into the 4.3-dev branch (closes #31040). Discussion ---------- [BrowserKit] Fixed BC-break introduced by rename of Client to Browser | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #31039 | License | MIT | Doc PR | Since #30541 the inheritance hierarchy of `\Symfony\Component\BrowserKit\Client` has changed. Notably the test.client no longer is an instance of `\Symfony\Component\BrowserKit\Client`. This PR uses `class_alias` to fix the class hierarchy similarly as has been done in Twig. In this case I copied the approach of `Twig_TokenParser_AutoEscape` and `\Twig\TokenParser\AutoEscapeTokenParser` Commits ------- 6a94dea [BrowserKit] Fixed BC-break introduced by rename of Client to Browser
Merged
fabpot
added a commit
that referenced
this pull request
Jun 6, 2019
…icolas-grekas) This PR was merged into the 4.3 branch. Discussion ---------- [FramworkBundle][HttpKernel] fix KernelBrowser BC layer | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #31762 | License | MIT | Doc PR | - Swap the order of inheritance to preserve BC with legacy `Client` type hints. From #30541 Commits ------- 1a4c254 [FramworkBundle][HttpKernel] fix KernelBrowser BC layer
This was referenced Jun 27, 2019
javiereguiluz
referenced
this pull request
in symfony/symfony-docs
Jun 8, 2020
…bstractBrowser since SF 4.3 (Calex92) This PR was merged into the 4.4 branch. Discussion ---------- [Browserkit] The Client class has been replaced by the AbstractBrowser since SF 4.3 I noticed that in the BrowserKit documentation, there was multiple references to the old ``Symfony\Component\BrowserKit\Client`` class instead of the ``Symfony\Component\BrowserKit\AbstractBrowser`` one. See [https://github.com/symfony/symfony/pull/30541](https://github.com/symfony/symfony/pull/30541) There was a previous merge request for SF5 here (#12717), but I don't know if it was possible for me to use it since I'm quite new with Github best practice about contribution. Don't hesitate to tell me if I'm wrong! Commits ------- a3ff4e0 The Client class has been replaced by the AbstractBrowser since SF 4.3
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.
Clientis very generic and used in 3 places: BrowserKit, HttpKernel, and FramewrokBundle. Each Client extends another one. So, to make things clearer, I'd like to rename Client to Browser like this:Symfony\Component\BrowerKit\Client -> AbstractBrowser
Symfony\Component\HttpKernel\Client -> HttpKernelBrowser
Symfony\Bundle\FrameworkBundle\Client -> KernelBrowser
The next PR will introduce an
HttpBrowserbased on the new HttpClient component :)