MediaWiki REL1_28
PhpHttpRequest Class Reference
Inheritance diagram for PhpHttpRequest:
Collaboration diagram for PhpHttpRequest:

Public Member Functions

 errorHandler ( $errno, $errstr)
 Custom error handler for dealing with fopen() errors.
 execute ()
 Take care of whatever is necessary to perform the URI request.
- Public Member Functions inherited from MWHttpRequest
 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.
 getHeaderList ()
 Get an array of the headers.
 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.
 proxySetup ()
 Take care of setting up the proxy (do nothing if "noProxy" is set)
 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=null, $attr=null)
 Sets a cookie.
 setCookieJar ( $jar)
 Tells the MWHttpRequest object to use this pre-loaded CookieJar.
 setData ( $args)
 Set the parameters of the request.
 setHeader ( $name, $value)
 Set an arbitrary header.
 setLogger (LoggerInterface $logger)
 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
 __construct ( $url, $options=[], $caller=__METHOD__, $profiler=null)
 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.
 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 (< 300) or a redirect (>=300 and < 400).

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, $options=null, $caller=__METHOD__)
 Generate a new request object.
- Public Attributes inherited from MWHttpRequest
- Protected Attributes inherited from MWHttpRequest
 $caInfo = null
CookieJar $cookieJar
 $followRedirects = false
 $headerList = []
 $headersOnly = null
 $maxRedirects = 5
 $method = "GET"
 $noProxy = false
 $postData = null
string $profileName
Profiler $profiler
 $proxy = null
 $reqHeaders = []
 $respHeaders = []
 $respStatus = "200 Ok"
 $respVersion = "0.9"
 $sslVerifyCert = true
 $sslVerifyHost = true
 $timeout = 'default'

Detailed Description

Definition at line 21 of file PhpHttpRequest.php.

Member Function Documentation

◆ errorHandler()

PhpHttpRequest::errorHandler (   $errno,

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()

◆ getCertOptions()

PhpHttpRequest::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.

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.


Definition at line 44 of file PhpHttpRequest.php.

References MWHttpRequest\$caInfo, as, and Debian.

Referenced by execute().

◆ urlToTcp()

PhpHttpRequest::urlToTcp (   $url)

Definition at line 29 of file PhpHttpRequest.php.

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

Referenced by execute().

Member Data Documentation

◆ $fopenErrors

PhpHttpRequest::$fopenErrors = []

Definition at line 23 of file PhpHttpRequest.php.

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