[HttpClient] Providing additional options to CurlHttpClient section #14195
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
nicolas-grekas
added a commit
to symfony/symfony
that referenced
this pull request
Sep 10, 2020
…to CurlHttpClient (pizzaminded) This PR was squashed before being merged into the 5.2-dev branch. Discussion ---------- [HttpClient] Allow to provide additional curl options to CurlHttpClient | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #37798 | License | MIT | Doc PR | symfony/symfony-docs#14195 ~~**Tagging as a draft because:**~~ - ~~there is no Doc PR Ready yet~~ - probably there are better test cases required here. This PR introduces an option to override default curl options defined in `CurlHttpClient`. To override them, there is a special place in `$options` provided: ````php $response = $httpClient->request('GET', 'http://your.url.here', [ 'extra' => [ 'curl' => [ CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4, ] ] ]); ```` This feature is available only in `CurlHttpClient` and would be ignored in another clients. Commits ------- 89329bd [HttpClient] Allow to provide additional curl options to CurlHttpClient
nicolas-grekas
approved these changes
Sep 10, 2020
OskarStark
reviewed
Sep 10, 2020
http_client.rst
Outdated
| @@ -728,6 +728,39 @@ When using this component in a full-stack Symfony application, this behavior is | |||
| not configurable and cURL will be used automatically if the cURL PHP extension | |||
| is installed and enabled. Otherwise, the native PHP streams will be used. | |||
|
|
|||
| Providing additional options to CurlHttpClient | |||
There was a problem hiding this comment.
Additional Options ...
Uppercase letters. Thanks
http_client.rst
Outdated
| Providing additional options to CurlHttpClient | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| It is possible to provide additional cURL options to CurlHttpClient. PHP exposes |
There was a problem hiding this comment.
CurlHttpClient in backticks please
http_client.rst
Outdated
|
|
||
| It is possible to provide additional cURL options to CurlHttpClient. PHP exposes | ||
| a lot of `cURL options`_ that can be passed to ``curl_setopt`` function, but only some | ||
| of them are used in CurlHttpClient in favor of bigger component portability. |
http_client.rst
Outdated
| // ... | ||
| 'extra' => [ | ||
| 'curl' => [ | ||
| \CURLOPT_IPRESOLVE => \CURL_IPRESOLVE_V6 |
There was a problem hiding this comment.
IMO we can remove the leading slashes to keep the example easier to read
e24a939 to
729c7df
Compare
|
Mikolaj, thanks and congrats on your first Symfony Docs contribution! It was a fantastic first-time contribution, but we made some minor rewords to make the new contents more similar to the existing contents (but we kept most of your original 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.
Documentation for symfony/symfony#38026 PR.