Curl
Extends AbstractTransportHTTP transport class for using cURL.
since |
1.0 |
---|---|
package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(array|\ArrayAccess options = []) : mixed
since |
2.0.0 |
---|---|
throws |
|
Arguments
- options
array|\ArrayAccess
Client options array.
Response
mixed
getOption
Get an option from the HTTP transport.
getOption(string key, mixed default = null) : mixed
since |
2.0.0 |
---|
Arguments
- key
string
The name of the option to get.- default
mixed
The default value if the option is not set.
Response
mixed
The option value.
getResponse
Method to get a response object from a server response.
getResponse(string content, array info) : \Joomla\Http\Response
since |
1.0 |
---|---|
throws |
|
Arguments
- content
string
The complete server response, including headers as a string if the response has no errors.- info
array
The cURL request information.
Response
\Joomla\Http\Response
isSupported
Method to check if HTTP transport cURL is available for use
isSupported() : bool
since |
1.0 |
---|
Response
bool
True if available, else false
mapProtocolVersion
Get the cURL constant for a HTTP protocol version
mapProtocolVersion(string version) : int
since |
1.3.1 |
---|
Arguments
- version
string
The HTTP protocol version to use
Response
int
processHeaders
Processes the headers from a transport's response data.
processHeaders(array headers) : array
since |
2.0.0 |
---|
Arguments
- headers
array
The headers to process.
Response
array
redirectsAllowed
Check if redirects are allowed
redirectsAllowed() : bool
since |
1.2.1 |
---|
Response
bool
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 = [], int timeout = null, string userAgent = null) : \Joomla\Http\Response
since |
1.0 |
---|---|
throws |
|
Arguments
- method
string
The HTTP method for sending the request.- uri
\Joomla\Uri\UriInterface
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
int
Read timeout in seconds.- userAgent
string
The optional user agent string to send with the request.
Response
\Joomla\Http\Response
setCAOptionAndValue
Configure the cURL resources with the appropriate root certificates.
setCAOptionAndValue(resource ch) : void
since |
1.3.2 |
---|
Arguments
- ch
resource
The cURL resource you want to configure the certificates on.
Properties
options
The client options.
since |
2.0.0 |
---|
Type(s)
array|\ArrayAccess