PhpHttpRequest Class Reference

Inheritance diagram for PhpHttpRequest:

Collaboration diagram for PhpHttpRequest:

Public Member Functions
	__construct ()
	errorHandler ( $errno, $errstr)
	Custom error handler for dealing with fopen() errors.
	execute ()
Public Member Functions inherited from MWHttpRequest
	__construct ( $url, array $options=[], $caller=__METHOD__, Profiler $profiler=null)
	canFollowRedirects ()
	Returns true if the backend can follow redirects.
	getContent ()
	Get the body, or content, of the response to the request.
	getCookieJar ()
	Returns the cookie jar in use.
	getFinalUrl ()
	Returns the final URL after all redirections.
	getResponseHeader ( $header)
	Returns the value of the given response header.
	getResponseHeaders ()
	Returns an associative array of response headers after the request has been executed.
	getStatus ()
	Get the integer value of the HTTP status code (e.g.
	isRedirect ()
	Returns true if the last status code was a redirect.
	read ( $fh, $content)
	A generic callback to read the body of the response from a remote server.
	setCallback ( $callback)
	Set a read callback to accept data read from the HTTP request.
	setCookie ( $name, $value, array $attr=[])
	Sets a cookie.
	setCookieJar (CookieJar $jar)
	Tells the MWHttpRequest object to use this pre-loaded CookieJar.
	setData (array $args)
	Set the parameters of the request.
	setHeader ( $name, $value)
	Set an arbitrary header.
	setLogger (LoggerInterface $logger)
	setOriginalRequest ( $originalRequest)
	Set information about the original request.
	setUserAgent ( $UA)
	Set the user agent.

Protected Member Functions
	getCertOptions ()
	Returns an array with a 'capath' or 'cafile' key that is suitable to be merged into the 'ssl' sub-array of a stream context options array.
	urlToTcp ( $url)
Protected Member Functions inherited from MWHttpRequest
	doSetCallback ( $callback)
	Worker function for setting callbacks.
	getHeaderList ()
	Get an array of the headers.
	parseCookies ()
	Parse the cookies in the response headers and store them in the cookie jar.
	parseHeader ()
	Parses the headers, including the HTTP status code and any Set-Cookie headers.
	prepare ()
	proxySetup ()
	Take care of setting up the proxy (do nothing if "noProxy" is set)
	setStatus ()
	Sets HTTPRequest status member to a fatal value with the error message if the returned integer value of the status code was not successful (1-299) or a redirect (300-399).

Private Attributes
	$fopenErrors = []

Additional Inherited Members
Static Public Member Functions inherited from MWHttpRequest
static	canMakeRequests ()
	Simple function to test if we can make any sort of requests at all, using cURL or fopen()
static	factory ( $url, array $options=null, $caller=__METHOD__)
	Generate a new request object.
static	isValidURI ( $uri)
	Check that the given URI is a valid one.
Public Attributes inherited from MWHttpRequest
const	SUPPORTS_FILE_POSTS = false
Protected Attributes inherited from MWHttpRequest
	$caInfo = null
callable	$callback
	$connectTimeout
	$content
CookieJar	$cookieJar
	$followRedirects = false
	$headerList = []
	$headersOnly = null
LoggerInterface	$logger
	$maxRedirects = 5
	$method = "GET"
	$noProxy = false
	$parsedUrl
	$postData = null
string	$profileName
Profiler	$profiler
	$proxy = null
array	$reqHeaders = []
string[][]	$respHeaders = []
	$respStatus = "200 Ok"
	$respVersion = "0.9"
	$sslVerifyCert = true
	$sslVerifyHost = true
StatusValue	$status
int string	$timeout = 'default'
	$url

Detailed Description

Definition at line 21 of file PhpHttpRequest.php.

Constructor & Destructor Documentation

__construct()

PhpHttpRequest::__construct

(

)

Definition at line 28 of file PhpHttpRequest.php.

References wfIniGetBool().

Member Function Documentation

errorHandler()

PhpHttpRequest::errorHandler	(		$errno,
			$errstr )

Custom error handler for dealing with fopen() errors.

fopen() tends to fire multiple errors in succession, and the last one is completely useless (something like "fopen: failed to open stream") so normal methods of handling errors programmatically like get_last_error() don't work.

Definition at line 91 of file PhpHttpRequest.php.

execute()

PhpHttpRequest::execute

(

)

See also

MWHttpRequest::execute

Returns

Status

Reimplemented from MWHttpRequest.

Definition at line 101 of file PhpHttpRequest.php.

References MWHttpRequest\$url, getCertOptions(), MWHttpRequest\getHeaderList(), MWHttpRequest\getResponseHeader(), MWHttpRequest\isRedirect(), Http\isValidURI(), MWHttpRequest\parseHeader(), MWHttpRequest\prepare(), MWHttpRequest\setStatus(), urlToTcp(), and wfArrayToCgi().

getCertOptions()

PhpHttpRequest::getCertOptions ( )

protected

Returns an array with a 'capath' or 'cafile' key that is suitable to be merged into the 'ssl' sub-array of a stream context options array.

Uses the 'caInfo' option of the class if it is provided, otherwise uses the system default CA bundle if PHP supports that, or searches a few standard locations.

Returns

array

Exceptions

DomainException

Definition at line 58 of file PhpHttpRequest.php.

Referenced by execute().

urlToTcp()

PhpHttpRequest::urlToTcp ( $url )

protected

Parameters

string

$url

Returns

string

Definition at line 43 of file PhpHttpRequest.php.

References MWHttpRequest\$parsedUrl, and MWHttpRequest\$url.

Referenced by execute().

Member Data Documentation

$fopenErrors

PhpHttpRequest::$fopenErrors = []

private

Definition at line 23 of file PhpHttpRequest.php.

---

The documentation for this class was generated from the following file:

• includes/http/PhpHttpRequest.php