Http Class Reference

Various HTTP related functions. More...

List of all members.

Static Public Member Functions
static	get ($url, $timeout= 'default', $options=array())
	Simple wrapper for Http::request( 'GET' )
static	isLocalURL ($url)
	Check if the URL can be served by localhost.
static	isValidURI ($uri)
	Checks that the given URI is a valid one.
static	post ($url, $options=array())
	Simple wrapper for Http::request( 'POST' )
static	request ($method, $url, $options=array())
	Perform an HTTP request.
static	userAgent ()
	A standard user-agent we can use for external requests.
Static Public Attributes
static	$httpEngine = false

---

Detailed Description

Various HTTP related functions.

Definition at line 32 of file HttpFunctions.php.

---

Member Function Documentation

static Http::get	(	$	url,
		$	timeout = 'default',
		$	options = array()
	)		[static]

Simple wrapper for Http::request( 'GET' )

See also:

Http::request()

Parameters:

$url
$timeout	string
$options	array

Returns:

string

Definition at line 93 of file HttpFunctions.php.

References $options, and request().

Referenced by bench_HTTP_HTTPS\doRequest(), ImportSiteScripts\execute(), ExternalStoreHttp\fetchFromURL(), ImportSiteScripts\fetchScriptList(), File\getDescriptionText(), getFileCommentFromSourceWiki(), getFileUserFromSourceWiki(), FindHooks\getHooksFromOnlineDoc(), and MediaWikiSite\normalizePageName().

static Http::isLocalURL

(

$

url

)

[static]

Check if the URL can be served by localhost.

Parameters:

string

$url

full url to check

Returns:

Boolean

Definition at line 116 of file HttpFunctions.php.

References $matches, $wgCommandLineMode, array(), and global.

static Http::isValidURI

(

$

uri

)

[static]

Checks that the given URI is a valid one.

Hardcoding the protocols, because we only want protocols that both cURL and php support.

file:// should not be allowed here for security purpose (r67684)

Todo:

FIXME this is wildly inaccurate and fails to actually check most stuff

Parameters:

$uri	Mixed: URI to check for validity

Returns:

Boolean

Definition at line 171 of file HttpFunctions.php.

Referenced by PhpHttpRequest\execute(), UploadFromUrl\fetchFile(), UploadFromUrl\isValidRequest(), and HttpTest\testIsValidUri().

static Http::post	(	$	url,
		$	options = array()
	)		[static]

Simple wrapper for Http::request( 'POST' )

See also:

Http::request()

Parameters:

$url
$options	array

Returns:

string

Definition at line 106 of file HttpFunctions.php.

References $options, and request().

static Http::request	(	$	method,
		$	url,
		$	options = array()
	)		[static]

Perform an HTTP request.

Parameters:

string	$method	HTTP method. Usually GET/POST
string	$url	full URL to act on. If protocol-relative, will be expanded to an http:// URL
array	$options	options to pass to MWHttpRequest object. Possible keys for the array: timeout Timeout length in seconds connectTimeout Timeout for connection, in seconds (curl only) postData An array of key-value pairs or a url-encoded form data proxy The proxy to use. Otherwise it will use $wgHTTPProxy (if set) Otherwise it will use the environment variable "http_proxy" (if set) noProxy Don't use any proxy at all. Takes precedence over proxy value(s). sslVerifyHost Verify hostname against certificate sslVerifyCert Verify SSL certificate caInfo Provide CA information maxRedirects Maximum number of redirects to follow (defaults to 5) followRedirects Whether to follow redirects (defaults to false). Note: this should only be used when the target URL is trusted, to avoid attacks on intranet services accessible by HTTP. userAgent A user agent, if you want to override the default MediaWiki/$wgVersion

Returns:

Mixed: (bool)false on failure or a string on success

Definition at line 60 of file HttpFunctions.php.

References $options, MWHttpRequest\factory(), wfDebug(), wfProfileIn(), and wfProfileOut().

Referenced by get(), and post().

static Http::userAgent

(

)

[static]

A standard user-agent we can use for external requests.

Returns:

String

Definition at line 154 of file HttpFunctions.php.

References global.

Referenced by ForeignAPIRepo\getUserAgent(), and SquidPurgeClient\queuePurge().

---

Member Data Documentation

Http::$httpEngine = false [static]

Definition at line 33 of file HttpFunctions.php.

Referenced by MWHttpRequestTester\factory().

---

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

• includes/HttpFunctions.php