Documentation

Horde_Http_Request_PeclhttpBase extends Horde_Http_Request_Base
in package

Base HTTP request object for the pecl_http backends.

Tags
author

Michael Cramer michael@bigmichi1.de

category

Horde

copyright

2007-2017 Horde LLC

license

http://www.horde.org/licenses/bsd BSD

Table of Contents

$authenticationScheme  : string
$data  : array<string|int, mixed>|string
$headers  : array<string|int, mixed>
$method  : string
$password  : string
$proxyAuthenticationScheme  : string
$proxyPassword  : string
$proxyPort  : int
$proxyServer  : string
$proxyType  : int
$proxyUsername  : string
$redirects  : int
$timeout  : int
$uri  : string|Horde_Url
$userAgent  : string
$username  : string
$verifyPeer  : bool
$_headers  : array<string|int, mixed>
Request headers
$_httpAuthSchemes  : array<string|int, mixed>
Map of HTTP authentication schemes from Horde_Http constants to implementation specific constants.
$_options  : array<string|int, mixed>
$_proxyTypes  : array<string|int, mixed>
Map of proxy types from Horde_Http to implementation specific constants.
__construct()  : mixed
Constructor
__get()  : mixed
Get an adapter parameter
__set()  : mixed
Set a request parameter
getDefaultOptions()  : mixed
getHeader()  : string
Get the current value of $header
send()  : Horde_Http_Response_Base
Send this HTTP request
setHeaders()  : mixed
Set one or more headers
setOptions()  : mixed
_httpAuthScheme()  : const
Translates a Horde_Http::AUTH_* constant to implementation specific constants.
_httpOptions()  : array<string|int, mixed>
Generates the HTTP options for the request.
_proxyType()  : const
Translates a Horde_Http::PROXY_* constant to implementation specific constants.

Properties

$authenticationScheme

public string $authenticationScheme

Authentication method, one of the Horde_Http::AUTH_* constants.

$data

public array<string|int, mixed>|string $data

POST data fields or POST/PUT data body.

$headers

public array<string|int, mixed> $headers

Hash with additional request headers.

$method

public string $method

Default request method if not specified for individual requests.

$password

public string $password

Authentication password.

$proxyAuthenticationScheme

public string $proxyAuthenticationScheme

Proxy authentication method, one of the Horde_Http::AUTH_* constants.

$proxyPassword

public string $proxyPassword

Proxy authentication password.

$proxyPort

public int $proxyPort

Port number of a proxy server.

$proxyServer

public string $proxyServer

Host name of a proxy server.

$proxyType

public int $proxyType

Proxy server type, one of the Horde_Http::PROXY_* constants.

$proxyUsername

public string $proxyUsername

Proxy authentication user name.

$redirects

public int $redirects

Maximum number of redirects to follow.

$timeout

public int $timeout

Timeout in seconds.

$uri

public string|Horde_Url $uri

Default URI if not specified for individual requests.

$userAgent

public string $userAgent

User-Agent: request header contents.

$username

public string $username

Authentication user name.

$verifyPeer

public bool $verifyPeer

Verify SSL peer certificates?

$_headers

Request headers

protected array<string|int, mixed> $_headers = array()

$_httpAuthSchemes

Map of HTTP authentication schemes from Horde_Http constants to implementation specific constants.

protected array<string|int, mixed> $_httpAuthSchemes = array()

$_options

protected array<string|int, mixed> $_options = array()

$_proxyTypes

Map of proxy types from Horde_Http to implementation specific constants.

protected array<string|int, mixed> $_proxyTypes = array()

Methods

__construct()

Constructor

public __construct([mixed $options = array() ]) : mixed
Parameters
$options : mixed = array()
Return values
mixed

__get()

Get an adapter parameter

public __get(string $name) : mixed
Parameters
$name : string

The parameter to get.

Return values
mixed

Parameter value.

__set()

Set a request parameter

public __set(string $name, mixed $value) : mixed
Parameters
$name : string

The parameter to set.

$value : mixed

Parameter value.

Return values
mixed

getDefaultOptions()

public getDefaultOptions() : mixed
Return values
mixed

getHeader()

Get the current value of $header

public getHeader(string $header) : string
Parameters
$header : string

Header name to get

Return values
string

$header's current value

setHeaders()

Set one or more headers

public setHeaders(mixed $headers[, string $value = null ]) : mixed
Parameters
$headers : mixed

A hash of header + value pairs, or a single header name

$value : string = null

A header value

Return values
mixed

setOptions()

public setOptions([mixed $options = array() ]) : mixed
Parameters
$options : mixed = array()
Return values
mixed

_httpAuthScheme()

Translates a Horde_Http::AUTH_* constant to implementation specific constants.

protected _httpAuthScheme(string $httpAuthScheme) : const
Parameters
$httpAuthScheme : string

A Horde_Http::AUTH_* constant.

Tags
throws
Horde_Http_Exception
Return values
const

An implementation specific authentication scheme constant.

_httpOptions()

Generates the HTTP options for the request.

protected _httpOptions() : array<string|int, mixed>
Tags
throws
Horde_Http_Exception
Return values
array<string|int, mixed>

array with options

_proxyType()

Translates a Horde_Http::PROXY_* constant to implementation specific constants.

protected _proxyType() : const
Tags
throws
Horde_Http_Exception
Return values
const

Search results