Public Member Functions |
Public Attributes |
Protected Member Functions |
Protected Attributes |
List of all members
CurlHttpRequest Class Reference
MWHttpRequest implemented using internal curl compiled into PHP. More...
Inheritance diagram for CurlHttpRequest:
Collaboration diagram for CurlHttpRequest:
Public Member Functions | |
| __construct () | |
| canFollowRedirects () | |
| execute () | |
 Public Member Functions inherited from MWHttpRequest | |
| __construct ( $url, array $options=[], $caller=__METHOD__, Profiler $profiler=null) | |
| getContent () | |
| Get the body, or content, of the response to the request. More... | |
| getCookieJar () | |
| Returns the cookie jar in use. More... | |
| getFinalUrl () | |
| Returns the final URL after all redirections. More... | |
| getResponseHeader ( $header) | |
| Returns the value of the given response header. More... | |
| getResponseHeaders () | |
| Returns an associative array of response headers after the request has been executed. More... | |
| getStatus () | |
| Get the integer value of the HTTP status code (e.g. More... | |
| isRedirect () | |
| Returns true if the last status code was a redirect. More... | |
| read ( $fh, $content) | |
| A generic callback to read the body of the response from a remote server. More... | |
| setCallback ( $callback) | |
| Set a read callback to accept data read from the HTTP request. More... | |
| setCookie ( $name, $value, array $attr=[]) | |
| Sets a cookie. More... | |
| setCookieJar (CookieJar $jar) | |
| Tells the MWHttpRequest object to use this pre-loaded CookieJar. More... | |
| setData (array $args) | |
| Set the parameters of the request. More... | |
| setHeader ( $name, $value) | |
| Set an arbitrary header. More... | |
| setLogger (LoggerInterface $logger) | |
| setOriginalRequest ( $originalRequest) | |
| Set information about the original request. More... | |
| setUserAgent ( $UA) | |
| Set the user agent. More... | |
Public Attributes | |
| const | SUPPORTS_FILE_POSTS = true |
| Public Attributes inherited from MWHttpRequest | |
| const | SUPPORTS_FILE_POSTS = false |
Protected Member Functions | |
| readHeader ( $fh, $content) | |
| Protected Member Functions inherited from MWHttpRequest | |
| doSetCallback ( $callback) | |
| Worker function for setting callbacks. More... | |
| getHeaderList () | |
| Get an array of the headers. More... | |
| parseCookies () | |
| Parse the cookies in the response headers and store them in the cookie jar. More... | |
| parseHeader () | |
| Parses the headers, including the HTTP status code and any Set-Cookie headers. More... | |
| prepare () | |
| proxySetup () | |
| Take care of setting up the proxy (do nothing if "noProxy" is set) More... | |
| 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). More... | |
Protected Attributes | |
| $curlOptions = [] | |
| $headerText = "" | |
| 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 | |
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() More... | |
| static | factory ( $url, array $options=null, $caller=__METHOD__) |
| Generate a new request object. More... | |
| static | isValidURI ( $uri) |
| Check that the given URI is a valid one. More... | |
Detailed Description
MWHttpRequest implemented using internal curl compiled into PHP.
Definition at line 24 of file CurlHttpRequest.php.
Constructor & Destructor Documentation
◆ __construct()
| CurlHttpRequest::__construct | ( | ) |
- Exceptions
-
RuntimeException
Definition at line 33 of file CurlHttpRequest.php.
Member Function Documentation
◆ canFollowRedirects()
| CurlHttpRequest::canFollowRedirects | ( | ) |
- Returns
- bool
Reimplemented from MWHttpRequest.
Definition at line 153 of file CurlHttpRequest.php.
Referenced by execute().
◆ execute()
| CurlHttpRequest::execute | ( | ) |
- See also
- MWHttpRequest::execute
- Exceptions
-
MWException
- Returns
- Status
Reimplemented from MWHttpRequest.
Definition at line 58 of file CurlHttpRequest.php.
References MWHttpRequest\$caInfo, MWHttpRequest\$callback, MWHttpRequest\$maxRedirects, MWHttpRequest\$method, MWHttpRequest\$postData, MWHttpRequest\$proxy, MWHttpRequest\$sslVerifyCert, MWHttpRequest\$timeout, canFollowRedirects(), MWHttpRequest\getHeaderList(), MWHttpRequest\parseHeader(), MWHttpRequest\prepare(), MWHttpRequest\setStatus(), and Status\wrap().
◆ readHeader()
|
protected |
- Parameters
-
resource $fh string $content
- Returns
- int
Definition at line 47 of file CurlHttpRequest.php.
References MWHttpRequest\$content.
Member Data Documentation
◆ $curlOptions
|
protected |
Definition at line 27 of file CurlHttpRequest.php.
◆ $headerText
|
protected |
Definition at line 28 of file CurlHttpRequest.php.
◆ SUPPORTS_FILE_POSTS
| const CurlHttpRequest::SUPPORTS_FILE_POSTS = true |
Definition at line 25 of file CurlHttpRequest.php.
The documentation for this class was generated from the following file:
- includes/http/CurlHttpRequest.php
