PHPXRef 0.7.1 : WordPress : Detail view of class-requests.php

Requests for PHP

Inspired by Requests for Python.

Based on concepts from SimplePie_File, RequestCore and WP_Http.

This is a static class, do not instantiate it

Autoloader for Requests

Register this with {@see register_autoloader()} if you'd like to avoid
having to create your own.

(You can also use `spl_autoload_register` directly if you'd prefer.)

param: string $class Class name to load

register_autoloader() X-Ref

Register the built-in autoloader

add_transport($transport) X-Ref

Register a transport

param: string $transport Transport class to add, must support the Requests_Transport interface

get_transport($capabilities = array() X-Ref

Get a working transport

return: Requests_Transport

get($url, $headers = array() X-Ref

Send a GET request

head($url, $headers = array() X-Ref

Send a HEAD request

delete($url, $headers = array() X-Ref

Send a DELETE request

trace($url, $headers = array() X-Ref

Send a TRACE request

post($url, $headers = array() X-Ref

Send a POST request

put($url, $headers = array() X-Ref

Send a PUT request

options($url, $headers = array() X-Ref

Send an OPTIONS request

patch($url, $headers, $data = array() X-Ref

Send a PATCH request

Note: Unlike {@see post} and {@see put}, `$headers` is required, as the
specification recommends that should send an ETag

request($url, $headers = array() X-Ref

Main interface for HTTP requests

This method initiates a request and sends it via a transport before
parsing.

The `$options` parameter takes an associative array with the following
options:

- `timeout`: How long should we wait for a response?
Note: for cURL, a minimum of 1 second applies, as DNS resolution
operates at second-resolution only.
(float, seconds with a millisecond precision, default: 10, example: 0.01)
- `connect_timeout`: How long should we wait while trying to connect?
(float, seconds with a millisecond precision, default: 10, example: 0.01)
- `useragent`: Useragent to send to the server
(string, default: php-requests/$version)
- `follow_redirects`: Should we follow 3xx redirects?
(boolean, default: true)
- `redirects`: How many times should we redirect before erroring?
(integer, default: 10)
- `blocking`: Should we block processing on this request?
(boolean, default: true)
- `filename`: File to stream the body to instead.
(string|boolean, default: false)
- `auth`: Authentication handler or array of user/password details to use
for Basic authentication
(Requests_Auth|array|boolean, default: false)
- `proxy`: Proxy details to use for proxy by-passing and authentication
(Requests_Proxy|array|string|boolean, default: false)
- `max_bytes`: Limit for the response body size.
(integer|boolean, default: false)
- `idn`: Enable IDN parsing
(boolean, default: true)
- `transport`: Custom transport. Either a class name, or a
transport object. Defaults to the first working transport from
{@see getTransport()}
(string|Requests_Transport, default: {@see getTransport()})
- `hooks`: Hooks handler.
(Requests_Hooker, default: new Requests_Hooks())
- `verify`: Should we verify SSL certificates? Allows passing in a custom
certificate file as a string. (Using true uses the system-wide root
certificate store instead, but this may have different behaviour
across transports.)
(string|boolean, default: library/Requests/Transport/cacert.pem)
- `verifyname`: Should we verify the common name in the SSL certificate?
(boolean, default: true)
- `data_format`: How should we send the `$data` parameter?
(string, one of 'query' or 'body', default: 'query' for
HEAD/GET/DELETE, 'body' for POST/PUT/OPTIONS/PATCH)

return: Requests_Response
param: string $url URL to request
param: array $headers Extra headers to send with the request
param: array|null $data Data to send either as a query string for GET/HEAD requests, or in the body for POST requests
param: string $type HTTP request type (use Requests constants)
param: array $options Options for the request (see description for more information)

request_multiple($requests, $options = array() X-Ref

Send multiple HTTP requests simultaneously

The `$requests` parameter takes an associative or indexed array of
request fields. The key of each request can be used to match up the
request with the returned data, or with the request passed into your
`multiple.request.complete` callback.

The request fields value is an associative array with the following keys:

- `url`: Request URL Same as the `$url` parameter to
{@see Requests::request}
(string, required)
- `headers`: Associative array of header fields. Same as the `$headers`
parameter to {@see Requests::request}
(array, default: `array()`)
- `data`: Associative array of data fields or a string. Same as the
`$data` parameter to {@see Requests::request}
(array|string, default: `array()`)
- `type`: HTTP request type (use Requests constants). Same as the `$type`
parameter to {@see Requests::request}
(string, default: `Requests::GET`)
- `cookies`: Associative array of cookie name to value, or cookie jar.
(array|Requests_Cookie_Jar)

If the `$options` parameter is specified, individual requests will
inherit options from it. This can be used to use a single hooking system,
or set all the types to `Requests::POST`, for example.

In addition, the `$options` parameter takes the following global options:

- `complete`: A callback for when a request is complete. Takes two
parameters, a Requests_Response/Requests_Exception reference, and the
ID from the request array (Note: this can also be overridden on a
per-request basis, although that's a little silly)
(callback)

return: array Responses (either Requests_Response or a Requests_Exception object)
param: array $requests Requests data (see description for more information)
param: array $options Global and default options (see {@see Requests::request})

get_default_options($multirequest = false) X-Ref

Get the default options

return: array Default option values
param: boolean $multirequest Is this a multirequest?

get_certificate_path() X-Ref

Get default certificate path.

return: string Default certificate path.

set_certificate_path($path) X-Ref

Set default certificate path.

param: string $path Certificate path, pointing to a PEM file.

set_defaults(&$url, &$headers, &$data, &$type, &$options) X-Ref

Set the default values

return: array $options
param: string $url URL to request
param: array $headers Extra headers to send with the request
param: array|null $data Data to send either as a query string for GET/HEAD requests, or in the body for POST requests
param: string $type HTTP request type
param: array $options Options for the request

parse_response($headers, $url, $req_headers, $req_data, $options) X-Ref

HTTP response parser

return: Requests_Response
param: string $headers Full response text including headers and body
param: string $url Original request URL
param: array $req_headers Original $headers array passed to {@link request()}, in case we need to follow redirects
param: array $req_data Original $data array passed to {@link request()}, in case we need to follow redirects
param: array $options Original $options array passed to {@link request()}, in case we need to follow redirects

parse_multiple(&$response, $request) X-Ref

Callback for `transport.internal.parse_response`

Internal use only. Converts a raw HTTP response to a Requests_Response
while still executing a multiple request.

return: null `$response` is either set to a Requests_Response instance, or a Requests_Exception object
param: string $response Full response text including headers and body (will be overwritten with Response instance)
param: array $request Request data as passed into {@see Requests::request_multiple()}

decode_chunked($data) X-Ref

Decoded a chunked body as per RFC 2616

return: string Decoded body
param: string $data Chunked body

flatten($array) X-Ref

Convert a key => value array to a 'key: value' array for headers

return: array List of headers
param: array $array Dictionary of header values

flattern($array) X-Ref

Convert a key => value array to a 'key: value' array for headers

return: array List of headers
param: array $array Dictionary of header values

decompress($data) X-Ref

Decompress an encoded body

Implements gzip, compress and deflate. Guesses which it is by attempting
to decode.

return: string Decompressed string
param: string $data Compressed data in one of the above formats

compatible_gzinflate($gz_data) X-Ref

Decompression of deflated string while staying compatible with the majority of servers.

Certain Servers will return deflated data with headers which PHP's gzinflate()
function cannot handle out of the box. The following function has been created from
various snippets on the gzinflate() PHP documentation.

Warning: Magic numbers within. Due to the potential different formats that the compressed
data may be returned in, some "magic offsets" are needed to ensure proper decompression
takes place. For a simple progmatic way to determine the magic offset in use, see:
https://core.trac.wordpress.org/ticket/18273

return: string|bool False on failure.
param: string $gz_data String to decompress.
since: 2.8.1

match_domain($host, $reference) X-Ref

No description

File Size:	1001 lines (30 kb)
Included or required:	1 time
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of WordPress

/wp-includes/ -> class-requests.php (summary)

Defines 1 class