PHP Class Horde_Http_Client, horde

Author: Chuck Hagenbuch ([email protected])
Mostra file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_httpMethodOverride boolean Use POST instead of PUT and DELETE, sending X-HTTP-Method-Override with the intended method name instead.
$_lastRequest Horde_Http_Request_Base The previous HTTP request.
$_lastResponse Horde_Http_Response_Base The most recent HTTP response.
$_request Horde_Http_Request_Base The current HTTP request.

Public Methods

Method Description
__construct ( array $args = [] ) Horde_Http_Client constructor.
__get ( string $name ) : mixed Returns a client parameter.
__set ( string $name, mixed $value ) Sets a client parameter.
delete ( string $uri = null, array $headers = [] ) : Horde_Http_Response_Base Sends a DELETE request.
get ( string $uri = null, array $headers = [] ) : Horde_Http_Response_Base Sends a GET request.
head ( string $uri = null, array $headers = [] ) : Horde_Http_Response_Base Sends a HEAD request.
post ( string $uri = null, array | string $data = null, array $headers = [] ) : Horde_Http_Response_Base Sends a POST request.
put ( string $uri = null, string $data = null, array $headers = [] ) : Horde_Http_Response_Base Sends a PUT request.
request ( string $method, string | Horde_Url $uri = null, string | array $data = null, array $headers = [] ) : Horde_Http_Response_Base Sends an HTTP request.

Method Details

__construct() public method

Horde_Http_Client constructor.
public __construct ( array $args = [] )
$args array Any Http_Client settings to initialize in the constructor. See the class properties for available settings.

__get() public method

Returns a client parameter.
public __get ( string $name ) : mixed
$name string The parameter to return.
return mixed The parameter value.

__set() public method

Sets a client parameter.
public __set ( string $name, mixed $value )
$name string The parameter to set.
$value mixed The parameter value.

delete() public method

Sends a DELETE request.
public delete ( string $uri = null, array $headers = [] ) : Horde_Http_Response_Base
$uri string Request URI.
$headers array Additional request headers.
return Horde_Http_Response_Base

get() public method

Sends a GET request.
public get ( string $uri = null, array $headers = [] ) : Horde_Http_Response_Base
$uri string Request URI.
$headers array Additional request headers.
return Horde_Http_Response_Base

head() public method

Sends a HEAD request.
public head ( string $uri = null, array $headers = [] ) : Horde_Http_Response_Base
$uri string Request URI.
$headers array Additional request headers.
return Horde_Http_Response_Base

post() public method

Sends a POST request.
public post ( string $uri = null, array | string $data = null, array $headers = [] ) : Horde_Http_Response_Base
$uri string Request URI.
$data array | string Data fields or data body.
$headers array Additional request headers.
return Horde_Http_Response_Base

put() public method

Sends a PUT request.
public put ( string $uri = null, string $data = null, array $headers = [] ) : Horde_Http_Response_Base
$uri string Request URI.
$data string Data body.
$headers array Additional request headers.
return Horde_Http_Response_Base

request() public method

Sends an HTTP request.
public request ( string $method, string | Horde_Url $uri = null, string | array $data = null, array $headers = [] ) : Horde_Http_Response_Base
$method string HTTP request method (GET, PUT, etc.)
$uri string | Horde_Url URI to request, if different from $this->uri
$data string | array Request data. Array of form data that will be encoded automatically, or a raw string.
$headers array Any headers specific to this request. They will be combined with $this->_headers, and override headers of the same name for this request only.
return Horde_Http_Response_Base

Property Details

$_httpMethodOverride protected_oe property

Use POST instead of PUT and DELETE, sending X-HTTP-Method-Override with the intended method name instead.
protected bool $_httpMethodOverride
return boolean

$_lastRequest protected_oe property

The previous HTTP request.
protected Horde_Http_Request_Base $_lastRequest
return Horde_Http_Request_Base

$_lastResponse protected_oe property

The most recent HTTP response.
protected Horde_Http_Response_Base $_lastResponse
return Horde_Http_Response_Base

$_request protected_oe property

The current HTTP request.
protected Horde_Http_Request_Base $_request
return Horde_Http_Request_Base