Skip to content

[HttpClient] HTTP client is enabled by default when installed #13937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 6, 2020
Merged

[HttpClient] HTTP client is enabled by default when installed #13937

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 40 additions & 40 deletions http_client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ supports synchronous and asynchronous operations. You can install it with:
Basic Usage
-----------

Use the :class:`Symfony\\Component\\HttpClient\\HttpClient` class to create the
low-level HTTP client that makes requests, like the following ``GET`` request:
Use the :class:`Symfony\\Component\\HttpClient\\HttpClient` class to make
requests. In the Symfony framework, this class is available as the
``http_client`` service. This service will be :doc:`autowired </service_container/autowiring>`
automatically when type-hinting for :class:`Symfony\\Component\\HttpClient\\HttpClientInterface`:

.. configuration-block::

Expand Down Expand Up @@ -77,38 +79,11 @@ low-level HTTP client that makes requests, like the following ``GET`` request:
$content = $response->toArray();
// $content = ['id' => 521583, 'name' => 'symfony-docs', ...]

In the Symfony framework, you have to enable the HTTP client integration in
order for the ``HttpClientInterface`` to be :doc:`autowired </service_container/autowiring>`
automatically:

.. configuration-block::

.. code-block:: yaml

# config/packages/framework.yaml
framework:
http_client: true

.. code-block:: xml

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:framework="http://symfony.com/schema/dic/symfony"
xsi:schemaLocation="http://symfony.com/schema/dic/services
https://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
.. tip::

<framework:config http-client="true"/>
</container>

.. code-block:: php

// config/packages/framework.php
$container->loadFromExtension('framework', [
'http_client' => true,
]);
The HTTP client is interopable with many common HTTP client abstractions in
PHP. You can also use any of these abstractions to profit from autowirings.
See `Interoperability`_ for more information.

Configuration
-------------
Expand Down Expand Up @@ -1202,17 +1177,42 @@ To use it, you need the ``psr/http-client`` package and a `PSR-17`_ implementati
# any already installed implementations from common vendors:
# composer require php-http/discovery

Now you can make HTTP requests with the PSR-18 client as follows::
Now you can make HTTP requests with the PSR-18 client as follows:

.. configuration-block::

.. code-block:: php-symfony

use Psr\Http\Client\ClientInterface;

class Symfony
{
private $client;

public function __construct(ClientInterface $client)
{
$this->client = $client;
}

public function getAvailableVersions(): array
{
$request = $this->client->createRequest('GET', 'https://symfony.com/versions.json');
$response = $this->client->sendRequest($request);

return json_decode($response->getBody()->getContents(), true);
}
}

.. code-block:: php-standalone

use Symfony\Component\HttpClient\Psr18Client;
use Symfony\Component\HttpClient\Psr18Client;

$client = new Psr18Client();
$client = new Psr18Client();

$url = 'https://symfony.com/versions.json';
$request = $client->createRequest('GET', $url);
$response = $client->sendRequest($request);
$request = $client->createRequest('GET', 'https://symfony.com/versions.json');
$response = $client->sendRequest($request);

$content = json_decode($response->getBody()->getContents(), true);
$content = json_decode($response->getBody()->getContents(), true);

.. versionadded:: 4.4

Expand Down