separate clients overview, deprecate EOL guzzle 6 and clarify symfony…

… client
php-http · Jan 6, 2024 · 5d7c57b · 5d7c57b
1 parent 0e99354
commit 5d7c57b
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 8 deletions.
diff --git a/clients.rst b/clients.rst
@@ -26,21 +26,41 @@ interface and forwarding the calls to an HTTP client not implementing the interf
    clients/react-adapter
    clients/zend-adapter
 
+Current Clients and Adapters
+----------------------------
+
+.. hint::
+
+    Modern PHP clients implement the ``PSR-18 HTTP Client`` standard. If you want to do synchronous requests, you don't
+    need a PHP-HTTP adapter anymore. We keep providing the the curl client and a mock client for testing.
+
+    The adapters are still useful if you need the PHP-HTTP ``HttpAsyncClient``.
+
 .. csv-table::
    :header: "Name", "Type", "Links", "Stats"
    :widths: 32, 15, 15, 38
 
    "``php-http/curl-client``", "Client", ":doc:`Docs </clients/curl-client>`, `Repo <https://github.com/php-http/curl-client>`__", "|curl_version| |curl_downloads| "
-   "``php-http/socket-client``", "Client", ":doc:`Docs </clients/socket-client>`, `Repo <https://github.com/php-http/socket-client>`__", "|socket_version| |socket_downloads| "
    "``php-http/mock-client``", "Client", ":doc:`Docs </clients/mock-client>`, `Repo <https://github.com/php-http/mock-client>`__", "|mock_version| |mock_downloads| "
    "``symfony/http-client``", "Client", ":doc:`Docs </clients/symfony-client>`, `Repo <https://github.com/symfony/http-client>`__", "|symfony_version| |symfony_downloads| "
    "``php-http/artax-adapter``", "Adapter", ":doc:`Docs </clients/artax-adapter>`, `Repo <https://github.com/php-http/artax-adapter>`__", "|artax_version| |artax_downloads| "
    "``php-http/buzz-adapter``", "Adapter", ":doc:`Docs </clients/buzz-adapter>`, `Repo <https://github.com/php-http/buzz-adapter>`__", "|buzz_version| |buzz_downloads| "
    "``php-http/cakephp-adapter``", "Adapter", ":doc:`Docs </clients/cakephp-adapter>`, `Repo <https://github.com/php-http/cakephp-adapter>`__", "|cakephp_version| |cakephp_downloads| "
-   "``php-http/guzzle5-adapter``", "Adapter", ":doc:`Docs </clients/guzzle5-adapter>`, `Repo <https://github.com/php-http/guzzle5-adapter>`__", "|guzzle5_version| |guzzle5_downloads| "
-   "``php-http/guzzle6-adapter``", "Adapter", ":doc:`Docs </clients/guzzle6-adapter>`, `Repo <https://github.com/php-http/guzzle6-adapter>`__", "|guzzle6_version| |guzzle6_downloads| "
    "``php-http/guzzle7-adapter``", "Adapter", ":doc:`Docs </clients/guzzle7-adapter>`, `Repo <https://github.com/php-http/guzzle7-adapter>`__", "|guzzle7_version| |guzzle7_downloads| "
    "``php-http/react-adapter``", "Adapter", ":doc:`Docs </clients/react-adapter>`, `Repo <https://github.com/php-http/react-adapter>`__", "|react_version| |react_downloads| "
+
+Legacy Clients and Adapters
+---------------------------
+
+These are not maintained anymore, but we keep documentation around for now. Please upgrade your applications to use a maintained client or adapter.
+
+.. csv-table::
+   :header: "Name", "Type", "Links", "Stats"
+   :widths: 32, 15, 15, 38
+
+   "``php-http/socket-client``", "Client", ":doc:`Docs </clients/socket-client>`, `Repo <https://github.com/php-http/socket-client>`__", "|socket_version| |socket_downloads| "
+   "``php-http/guzzle5-adapter``", "Adapter", ":doc:`Docs </clients/guzzle5-adapter>`, `Repo <https://github.com/php-http/guzzle5-adapter>`__", "|guzzle5_version| |guzzle5_downloads| "
+   "``php-http/guzzle6-adapter``", "Adapter", ":doc:`Docs </clients/guzzle6-adapter>`, `Repo <https://github.com/php-http/guzzle6-adapter>`__", "|guzzle6_version| |guzzle6_downloads| "
    "``php-http/zend-adapter``", "Adapter", ":doc:`Docs </clients/zend-adapter>`, `Repo <https://github.com/php-http/zend-adapter>`__", "|zend_version| |zend_downloads| "
 
 Composer Virtual Packages

diff --git a/clients/guzzle6-adapter.rst b/clients/guzzle6-adapter.rst
@@ -1,8 +1,10 @@
-Guzzle 6 Adapter
-================
+Guzzle 6 Adapter (deprecated)
+=============================
 
 An HTTPlug adapter for the `Guzzle 6 HTTP client`_.
 
+Guzzle 5 is `not maintained anymore`_. We recommend to upgrade to Guzzle version 7.
+
 Installation
 ------------
 
@@ -66,3 +68,4 @@ Or send asynchronous ones::
 .. include:: includes/further-reading-async.inc
 
 .. _Guzzle 6 HTTP client: http://docs.guzzlephp.org/en/6.5/
+.. _not maintained anymore: https://github.com/guzzle/guzzle#version-guidance
diff --git a/clients/symfony-client.rst b/clients/symfony-client.rst
@@ -1,16 +1,19 @@
 Symfony Client
 ==============
 
-An HTTPlug implementation from the `Symfony HttpClient`_.
+The Symfony HTTP client provides a ``HttplugClient`` class that implements the ``Http\Client\HttpAsyncClient``.
+Until Symfony 5.4, it also implemented the ``Http\Client\HttpClient``, newer versions implement the PSR-18
+``HttpClientInterface`` instead.
 
 Installation
 ------------
 
-To install the Symfony client, run:
+The Symfony client does not depend on HTTPlug, but the ``HttplugClient`` does. To use the Symfony client with HTTPlug,
+you need to install both the client and HTTPlug with:
 
 .. code-block:: bash
 
-    $ composer require symfony/http-client
+    $ composer require symfony/http-client php-http/httplug
 
 This client does not come with a PSR-7 implementation out of the box. If you do
 not require one, `discovery <../discovery>` will install `Nyholm PSR-7`_. If