Class JHttp

Description

HTTP client class.

  • since: 11.3

Located in /libraries/joomla/http/http.php (line 21)


	
			
Direct descendents
Class Description
JGithubHttp HTTP client class for connecting to a GitHub instance.
Variable Summary
Method Summary
JHttp __construct ([JRegistry &$options = null], [JHttpTransport $transport = null])
JHttpResponse delete (string $url, [array $headers = null])
JHttpResponse get (string $url, [array $headers = null])
mixed getOption (string $key)
JHttpResponse head (string $url, [array $headers = null])
JHttpResponse options (string $url, [array $headers = null])
JHttpResponse post (string $url, mixed $data, [array $headers = null])
JHttpResponse put (string $url, mixed $data, [array $headers = null])
JHttp setOption (string $key, mixed $value)
JHttpResponse trace (string $url, [array $headers = null])
Variables
JRegistry $options (line 27)
  • var: Options for the HTTP client.
  • since: 11.3
  • access: protected
JHttpTransport $transport (line 33)
  • var: The HTTP transport object to use in sending HTTP requests.
  • since: 11.3
  • access: protected
Methods
Constructor __construct (line 43)

Constructor.

  • since: 11.3
  • access: public
JHttp __construct ([JRegistry &$options = null], [JHttpTransport $transport = null])

Redefined in descendants as:
delete (line 167)

Method to send the DELETE command to the server.

  • since: 11.3
  • access: public
JHttpResponse delete (string $url, [array $headers = null])
  • string $url: Path to the resource.
  • array $headers: An array of name-value pairs to include in the header of the request.
get (line 120)

Method to send the GET command to the server.

  • since: 11.3
  • access: public
JHttpResponse get (string $url, [array $headers = null])
  • string $url: Path to the resource.
  • array $headers: An array of name-value pairs to include in the header of the request.
getOption (line 58)

Get an option from the HTTP client.

  • return: The option value.
  • since: 11.3
  • access: public
mixed getOption (string $key)
  • string $key: The name of the option to get.
head (line 105)

Method to send the HEAD command to the server.

  • since: 11.3
  • access: public
JHttpResponse head (string $url, [array $headers = null])
  • string $url: Path to the resource.
  • array $headers: An array of name-value pairs to include in the header of the request.
options (line 90)

Method to send the OPTIONS command to the server.

  • since: 11.3
  • access: public
JHttpResponse options (string $url, [array $headers = null])
  • string $url: Path to the resource.
  • array $headers: An array of name-value pairs to include in the header of the request.
post (line 136)

Method to send the POST command to the server.

  • since: 11.3
  • access: public
JHttpResponse post (string $url, mixed $data, [array $headers = null])
  • string $url: Path to the resource.
  • mixed $data: Either an associative array or a string to be sent with the request.
  • array $headers: An array of name-value pairs to include in the header of the request.
put (line 152)

Method to send the PUT command to the server.

  • since: 11.3
  • access: public
JHttpResponse put (string $url, mixed $data, [array $headers = null])
  • string $url: Path to the resource.
  • mixed $data: Either an associative array or a string to be sent with the request.
  • array $headers: An array of name-value pairs to include in the header of the request.
setOption (line 73)

Set an option for the HTTP client.

  • return: This object for method chaining.
  • since: 11.3
  • access: public
JHttp setOption (string $key, mixed $value)
  • string $key: The name of the option to set.
  • mixed $value: The option value to set.
trace (line 182)

Method to send the TRACE command to the server.

  • since: 11.3
  • access: public
JHttpResponse trace (string $url, [array $headers = null])
  • string $url: Path to the resource.
  • array $headers: An array of name-value pairs to include in the header of the request.

Documentation generated on Mon, 25 Jun 2012 13:55:38 -0500 by phpDocumentor 1.4.4