StreamTransport
Implements \Joomla\CMS\Http\TransportInterfaceHTTP transport class for using PHP streams.
since |
1.7.3 |
---|
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options)
since |
1.7.3 |
---|---|
throws |
|
Arguments
- $options
\Joomla\Registry\Registry
Client options object.
getResponse
Method to get a response object from a server response.
getResponse(array $headers, string $body) : \Joomla\CMS\Http\Response
since |
1.7.3 |
---|---|
throws |
|
Arguments
- $headers
array
The response headers as an array.- $body
string
The response body as a string.
Response
isSupported
Method to check if http transport stream available for use
isSupported() : boolean
since |
3.0.0 |
---|
Response
boolean
true if available else false
request
Send a request to the server and return a HttpResponse object with the response.
request(string $method, \Joomla\CMS\Uri\Uri $uri, mixed $data = null, array $headers = null, integer $timeout = null, string $userAgent = null) : \Joomla\CMS\Http\Response
since |
1.7.3 |
---|---|
throws |
|
Arguments
- $method
string
The HTTP method for sending the request.- $uri
\Joomla\CMS\Uri\Uri
The URI to the resource to request.- $data
mixed
Either an associative array or a string to be sent with the request.- $headers
array
An array of request headers to send with the request.- $timeout
integer
Read timeout in seconds.- $userAgent
string
The optional user agent string to send with the request.