Skip to content

Commit 935ea46

Browse files
committed
Minor reword
1 parent 988d8e9 commit 935ea46

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

http_client.rst

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -728,15 +728,19 @@ When using this component in a full-stack Symfony application, this behavior is
728728
not configurable and cURL will be used automatically if the cURL PHP extension
729729
is installed and enabled. Otherwise, the native PHP streams will be used.
730730

731-
Providing Additional Options to CurlHttpClient
732-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
731+
Configuring CurlHttpClient Options
732+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
733733

734-
It is possible to provide additional cURL options to ``CurlHttpClient``. PHP exposes
735-
a lot of `cURL options`_ that can be passed to ``curl_setopt`` function, but only some
736-
of them are used in ``CurlHttpClient`` in favor of bigger component portability.
734+
.. versionadded:: 5.2
737735

738-
To provide cURL-related parameters to request, add an ``extra.curl`` option in your
739-
configuration::
736+
The feature to configure extra cURL options was introduced in Symfony 5.2.
737+
738+
PHP allows to configure lots of `cURL options`_ via the :phpfunction:`curl_setopt`
739+
function. In order to make the component more portable when not using cURL, the
740+
``CurlHttpClient`` only uses some of those options (and they are ignored in the
741+
rest of clients).
742+
743+
Add an ``extra.curl`` option in your configuration to pass those extra options::
740744

741745
use Symfony\Component\HttpClient\CurlHttpClient;
742746

@@ -751,15 +755,10 @@ configuration::
751755
]
752756
]);
753757

754-
755-
This option is available only when using ``CurlHttpClient``, other clients will ignore these options.
756-
757758
.. note::
758759

759-
Some cURL options are impossible to override due of. e.g Thread Safety or existing options in
760-
``$options`` configuration which will set given attributes internally. An exception will be
761-
thrown while overriding them.
762-
760+
Some cURL options are impossible to override (e.g. because of thread safety)
761+
and you'll get an exception when trying to override them.
763762

764763
HTTP/2 Support
765764
~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)