HttpServiceInterface
in
VuFind HTTP service interface definition.
Tags
Table of Contents
- createClient() : Client
- Return a new proxy client.
- get() : Response
- Perform a GET request.
- post() : Response
- Perform a POST request.
- postForm() : Response
- Post form data.
- proxify() : Client
- Proxify an existing client.
Methods
createClient()
Return a new proxy client.
public
createClient([string $url = null ][, string $method = LaminasHttpRequest::METHOD_GET ][, float $timeout = null ]) : Client
Parameters
- $url : string = null
-
Target URL
- $method : string = LaminasHttpRequest::METHOD_GET
-
Request method
- $timeout : float = null
-
Request timeout in seconds
Return values
Client —get()
Perform a GET request.
public
get(string $url[, array<string|int, mixed> $params = [] ][, float $timeout = null ][, array<string|int, mixed> $headers = [] ]) : Response
Parameters
- $url : string
-
Request URL
- $params : array<string|int, mixed> = []
-
Request parameters
- $timeout : float = null
-
Request timeout in seconds
- $headers : array<string|int, mixed> = []
-
Request headers
Return values
Response —post()
Perform a POST request.
public
post(string $url[, mixed $body = null ][, string $type = 'application/octet-stream' ][, float $timeout = null ][, array<string|int, mixed> $headers = [] ]) : Response
Parameters
- $url : string
-
Request URL
- $body : mixed = null
-
Request body document
- $type : string = 'application/octet-stream'
-
Request body content type
- $timeout : float = null
-
Request timeout in seconds
- $headers : array<string|int, mixed> = []
-
Request http-headers
Return values
Response —postForm()
Post form data.
public
postForm(string $url[, array<string|int, mixed> $params = [] ][, float $timeout = null ]) : Response
Parameters
- $url : string
-
Request URL
- $params : array<string|int, mixed> = []
-
Form data
- $timeout : float = null
-
Request timeout in seconds
Return values
Response —proxify()
Proxify an existing client.
public
proxify(Client $client[, array<string|int, mixed> $options = [] ]) : Client
Returns the client given as argument with appropriate proxy setup.
Parameters
- $client : Client
-
HTTP client
- $options : array<string|int, mixed> = []
-
ZF2 ProxyAdapter options