From 65209ad7d5013c9ddc31920f37b9761590935ea5 Mon Sep 17 00:00:00 2001 From: ShiSHcat Date: Sat, 24 Feb 2024 22:20:46 +0100 Subject: [PATCH] Replace RequestBody with HttpContent in documentation (#358) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c9935ed8..161b8490 100644 --- a/README.md +++ b/README.md @@ -108,17 +108,17 @@ $request->setBody("foobar"); #### Request Bodies -`Request::setBody($body)` allows changing the request body. Accepted types are `string`, `null`, and `RequestBody`. `string` and `null` are automatically converted to an instance of `RequestBody`. +`Request::setBody($body)` allows changing the request body. Accepted types are `string`, `null`, and `HttpContent`. `string` and `null` are automatically converted to an instance of `HttpContent`. > **Note** -> `RequestBody` is basically a factory for request bodies. We cannot simply accept streams here, because a request body might have to be sent again on a redirect / retry. Additionally, `RequestBody` allows the body to set headers, which can be used to automatically set headers such as `Content-Type: application/json` for a `JsonBody`. Note that headers set via `RequestBody::getHeaders()` are only applied if the `Request` doesn't have such a header. This allows overriding the default body header in a request. +> `HttpContent` is basically a factory for request bodies. We cannot simply accept streams here, because a request body might have to be sent again on a redirect / retry. ```php $request = new Request("https://httpbin.org/post", "POST"); $request->setBody("foobar"); ``` -`Request::getBody()` exposes the request body of the given `Request` object and will always return a `RequestBody`. +`Request::getBody()` exposes the request body of the given `Request` object and will always return a `HttpContent`. ### Response