IHttpClient
in
Interface for HTTP client operations abstraction.
Provides a testable abstraction over HTTP operations. Implementations can be real HTTP clients for production or mock clients for testing.
Table of Contents
Methods
- delete() : IHttpResponse
- Perform DELETE request
- get() : IHttpResponse
- Perform GET request
- post() : IHttpResponse
- Perform POST request with form data
- postJson() : IHttpResponse
- Perform POST request with JSON body
- put() : IHttpResponse
- Perform PUT request
- setDefaultHeaders() : void
- Set default headers for all requests
- setTimeout() : void
- Set timeout for requests
Methods
delete()
Perform DELETE request
public
delete(string $url[, array<string|int, mixed> $headers = [] ]) : IHttpResponse
Parameters
- $url : string
-
Request URL
- $headers : array<string|int, mixed> = []
-
Additional headers
Return values
IHttpResponse —Response object
get()
Perform GET request
public
get(string $url[, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : IHttpResponse
Parameters
- $url : string
-
Request URL
- $params : array<string|int, mixed> = []
-
Query parameters
- $headers : array<string|int, mixed> = []
-
Additional headers
Return values
IHttpResponse —Response object
post()
Perform POST request with form data
public
post(string $url[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $headers = [] ]) : IHttpResponse
Parameters
- $url : string
-
Request URL
- $data : array<string|int, mixed> = []
-
POST data
- $headers : array<string|int, mixed> = []
-
Additional headers
Return values
IHttpResponse —Response object
postJson()
Perform POST request with JSON body
public
postJson(string $url, string $json[, array<string|int, mixed> $headers = [] ]) : IHttpResponse
Parameters
- $url : string
-
Request URL
- $json : string
-
JSON string
- $headers : array<string|int, mixed> = []
-
Additional headers
Return values
IHttpResponse —Response object
put()
Perform PUT request
public
put(string $url[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $headers = [] ]) : IHttpResponse
Parameters
- $url : string
-
Request URL
- $data : array<string|int, mixed> = []
-
PUT data
- $headers : array<string|int, mixed> = []
-
Additional headers
Return values
IHttpResponse —Response object
setDefaultHeaders()
Set default headers for all requests
public
setDefaultHeaders(array<string|int, mixed> $headers) : void
Parameters
- $headers : array<string|int, mixed>
-
Headers to set
setTimeout()
Set timeout for requests
public
setTimeout(int $seconds) : void
Parameters
- $seconds : int
-
Timeout in seconds