Stream

Implements \Joomla\Http\TransportInterface

HTTP transport class for using PHP streams.

since

1.0

Methods

__construct

Constructor.

__construct(array|\ArrayAccess $options = array()) 
since

1.0

throws

\RuntimeException

Arguments

$options

array|\ArrayAccessClient options array.

getResponse

Method to get a response object from a server response.

getResponse(array $headers, string $body) : \Joomla\Http\Response
since

1.0

throws

\Joomla\Http\Exception\InvalidResponseCodeException

Arguments

$headers

arrayThe response headers as an array.

$body

stringThe response body as a string.

Response

\Joomla\Http\Response

isSupported

Method to check if http transport stream available for use

isSupported() : boolean
static
since

1.0

Response

booleanTrue if available else false

request

Send a request to the server and return a Response object with the response.

request(string $method, \Joomla\Uri\UriInterface $uri, mixed $data = null, array $headers = null, integer $timeout = null, string $userAgent = null) : \Joomla\Http\Response
since

1.0

throws

\RuntimeException

Arguments

$method

stringThe HTTP method for sending the request.

$uri

\Joomla\Uri\UriInterfaceThe URI to the resource to request.

$data

mixedEither an associative array or a string to be sent with the request.

$headers

arrayAn array of request headers to send with the request.

$timeout

integerRead timeout in seconds.

$userAgent

stringThe optional user agent string to send with the request.

Response

\Joomla\Http\Response

Properties

options

The client options.

since

1.0

Type(s)

array|\ArrayAccess