Class JHttp

HTTP client class.

Direct known subclasses

JGithubHttp, JMediawikiHttp

Package: Joomla\Platform\HTTP
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.3
Located at joomla/http/http.php

Methods summary

`public`	# `__construct( Joomla\Registry\Registry $options = null, JHttpTransport $transport = null )` Constructor. Constructor. Parameters `$options` `Joomla\Registry\Registry` - $options Client options object. If the registry contains any headers.* elements, these will be added to the request headers. `$transport` `JHttpTransport` - $transport The HTTP transport object. Since 11.3
`public mixed`	# `getOption( string $key )` Get an option from the HTTP client. Get an option from the HTTP client. Parameters `$key` `string` - $key The name of the option to get. Returns `mixed` - The option value. Since 11.3
`public JHttp`	# `setOption( string $key, mixed $value )` Set an option for the HTTP client. Set an option for the HTTP client. Parameters `$key` `string` - $key The name of the option to set. `$value` `mixed` - $value The option value to set. Returns `JHttp` - This object for method chaining. Since 11.3
`public JHttpResponse`	# `options( string $url, array $headers = null, integer $timeout = null )` Method to send the OPTIONS command to the server. Method to send the OPTIONS command to the server. Parameters `$url` `string` - $url Path to the resource. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request. `$timeout` `integer` - $timeout Read timeout in seconds. Returns `JHttpResponse` Since 11.3
`public JHttpResponse`	# `head( string $url, array $headers = null, integer $timeout = null )` Method to send the HEAD command to the server. Method to send the HEAD command to the server. Parameters `$url` `string` - $url Path to the resource. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request. `$timeout` `integer` - $timeout Read timeout in seconds. Returns `JHttpResponse` Since 11.3
`public JHttpResponse`	# `get( string $url, array $headers = null, integer $timeout = null )` Method to send the GET command to the server. Method to send the GET command to the server. Parameters `$url` `string` - $url Path to the resource. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request. `$timeout` `integer` - $timeout Read timeout in seconds. Returns `JHttpResponse` Since 11.3
`public JHttpResponse`	# `post( string $url, mixed $data, array $headers = null, integer $timeout = null )` Method to send the POST command to the server. Method to send the POST command to the server. Parameters `$url` `string` - $url Path to the resource. `$data` `mixed` - $data Either an associative array or a string to be sent with the request. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request `$timeout` `integer` - $timeout Read timeout in seconds. Returns `JHttpResponse` Since 11.3
`public JHttpResponse`	# `put( string $url, mixed $data, array $headers = null, integer $timeout = null )` Method to send the PUT command to the server. Method to send the PUT command to the server. Parameters `$url` `string` - $url Path to the resource. `$data` `mixed` - $data Either an associative array or a string to be sent with the request. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request. `$timeout` `integer` - $timeout Read timeout in seconds. Returns `JHttpResponse` Since 11.3
`public JHttpResponse`	# `delete( string $url, array $headers = null, integer $timeout = null )` Method to send the DELETE command to the server. Method to send the DELETE command to the server. Parameters `$url` `string` - $url Path to the resource. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request. `$timeout` `integer` - $timeout Read timeout in seconds. Returns `JHttpResponse` Since 11.3
`public JHttpResponse`	# `trace( string $url, array $headers = null, integer $timeout = null )` Method to send the TRACE command to the server. Method to send the TRACE command to the server. Parameters `$url` `string` - $url Path to the resource. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request. `$timeout` `integer` - $timeout Read timeout in seconds. Returns `JHttpResponse` Since 11.3
`public JHttpResponse`	# `patch( string $url, mixed $data, array $headers = null, integer $timeout = null )` Method to send the PATCH command to the server. Method to send the PATCH command to the server. Parameters `$url` `string` - $url Path to the resource. `$data` `mixed` - $data Either an associative array or a string to be sent with the request. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request. `$timeout` `integer` - $timeout Read timeout in seconds. Returns `JHttpResponse` Since 12.2

Magic methods summary

Properties summary

`protected Joomla\Registry\Registry`	`$options`	# Options for the HTTP client. Options for the HTTP client. Since 11.3
`protected JHttpTransport`	`$transport`	# The HTTP transport object to use in sending HTTP requests. The HTTP transport object to use in sending HTTP requests. Since 11.3

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JHttp

Direct known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since