HttpService

Implements \VuFindHttp\HttpServiceInterface

VuFind HTTP service.

category	VuFind
package	Http
author	David Maus maus@hab.de
license	http://opensource.org/licenses/gpl-2.0.php GNU General Public License
link	https://vufind.org/wiki/development

Methods

Constructor.

__construct(array $proxyConfig = array(), array $defaults = array(), array $config = array()) : void

Arguments

$proxyConfig

array

Proxy configuration

$defaults

array

Default HTTP options

$config

array

Other configuration

Return a new HTTP client.

createClient(string $url = null, string $method = \Laminas\Http\Request::METHOD_GET, float $timeout = null) : \Laminas\Http\Client

Arguments

$url

string

Target URL

$method

string

Request method

$timeout

float

Request timeout in seconds

Response

\Laminas\Http\Client

Return query string based on params.

createQueryString(array $params = array()) : string

Arguments

$params

array

Parameters

Response

string

Perform a GET request.

get(string $url, array $params = array(), float $timeout = null, array $headers = array()) : \Laminas\Http\Response

Arguments

$url

string

Request URL

$params

array

Request parameters

$timeout

float

Request timeout in seconds

$headers

array

Request headers

Response

\Laminas\Http\Response

Are we configured to use the CURL adapter?

hasCurlAdapterAsDefault() : boolean

Response

boolean

Return TRUE if argument is an associative array.

isAssocParams(array $array) : boolean

static

Arguments

$array

array

Array to test

Response

boolean

Return TRUE if argument refers to localhost.

isLocal(string $host) : boolean

Arguments

$host

string

Host to check

Response

boolean

Perform a POST request.

post(string $url, mixed $body = null, string $type = 'application/octet-stream', float $timeout = null, array $headers = array()) : \Laminas\Http\Response

Arguments

$url

string

Request URL

$body

mixed

Request body document

$type

string

Request body content type

$timeout

float

Request timeout in seconds

$headers

array

Request http-headers

Response

\Laminas\Http\Response

Post form data.

postForm(string $url, array $params = array(), float $timeout = null) : \Laminas\Http\Response

Arguments

$url

string

Request URL

$params

array

Form data

$timeout

float

Request timeout in seconds

Response

\Laminas\Http\Response

Proxify an existing client.

proxify(\Laminas\Http\Client $client, array $options = array()) : \Laminas\Http\Client

Returns the client given as argument with appropriate proxy setup.

Arguments

$client

\Laminas\Http\Client

HTTP client

$options

array

Laminas ProxyAdapter options

Response

\Laminas\Http\Client

Send HTTP request and return response.

send(\Laminas\Http\Client $client) : \Laminas\Http\Response

todo	Catch more exceptions, maybe?
Throws	\VuFindHttp\Exception\RuntimeException

Arguments

$client

\Laminas\Http\Client

HTTP client to use

Response

\Laminas\Http\Response

Set proxy options in a Curl adapter.

setCurlProxyOptions(\Laminas\Http\Client\Adapter\Curl $adapter) : void

Arguments

$adapter

\Laminas\Http\Client\Adapter\Curl

Adapter to configure

Set a default HTTP adapter (primarily for testing purposes).

setDefaultAdapter(\Laminas\Http\Client\Adapter\AdapterInterface $adapter) : void

Arguments

$adapter

\Laminas\Http\Client\Adapter\AdapterInterface

Adapter

Constants

Default regular expression matching a request to localhost.

LOCAL_ADDRESS_RE

var

Properties

Proxy configuration.

proxyConfig : array

see
var

Type(s)

array

Regular expression matching a request to localhost or hosts that are not proxied.

localAddressesRegEx : array

see
var

Type(s)

array

Default client options.

defaults : array

var

Type(s)

array

Default adapter

defaultAdapter : \Laminas\Http\Client\Adapter\AdapterInterface

var

Type(s)

\Laminas\Http\Client\Adapter\AdapterInterface