ExternalStore Class Reference

Static Public Member Functions
static	batchFetchFromURLs (array $urls)
	Fetch data from multiple URLs with a minimum of round trips.
static	fetchFromURL ( $url, array $params=[])
	Fetch data from given URL.
static	getStoreObject ( $proto, array $params=[])
	Get an external store object of the given type, with the given parameters.
static	insert ( $url, $data, array $params=[])
	Store a data item to an external store, identified by a partial URL The protocol part is used to identify the class, the rest is passed to the class itself as a parameter.
static	insertToDefault ( $data, array $params=[])
	Like insert() above, but does more of the work for us.
static	insertToForeignDefault ( $data, $wiki)
static	insertWithFallback (array $tryStores, $data, array $params=[])
	Like insert() above, but does more of the work for us.

Detailed Description

Deprecated

since 1.34 Use the ExternalStoreAccess service instead.

Definition at line 27 of file ExternalStore.php.

Member Function Documentation

batchFetchFromURLs()

static ExternalStore::batchFetchFromURLs ( array $urls )

static

Fetch data from multiple URLs with a minimum of round trips.

Parameters

array

$urls

The URLs of the text to get

Returns

array Map from url to its data. Data is either string when found or false on failure.

Exceptions

MWException

Deprecated

since 1.34

Definition at line 97 of file ExternalStore.php.

fetchFromURL()

static ExternalStore::fetchFromURL ( $url, array $params = [] )

static

Fetch data from given URL.

Parameters

string	$url	The URL of the text to get
array	$params	Associative array of ExternalStoreMedium parameters

Returns

string|bool The text stored or false on error

Exceptions

MWException

Deprecated

since 1.34

Definition at line 55 of file ExternalStore.php.

getStoreObject()

static ExternalStore::getStoreObject ( $proto, array $params = [] )

static

Get an external store object of the given type, with the given parameters.

Parameters

string	$proto	Type of external storage, should be a value in $wgExternalStores
array	$params	Associative array of ExternalStoreMedium parameters

Returns

ExternalStoreMedium|bool The store class or false on error

Deprecated

since 1.34

Definition at line 36 of file ExternalStore.php.

insert()

static ExternalStore::insert ( $url, $data, array $params = [] )

static

Store a data item to an external store, identified by a partial URL The protocol part is used to identify the class, the rest is passed to the class itself as a parameter.

Parameters

string	$url	A partial external store URL ("<store type>://<location>")
string	$data
array	$params	Associative array of ExternalStoreMedium parameters

Returns

string|bool The URL of the stored data item, or false on error

Exceptions

MWException

Deprecated

since 1.34

Definition at line 77 of file ExternalStore.php.

insertToDefault()

static ExternalStore::insertToDefault ( $data, array $params = [] )

static

Like insert() above, but does more of the work for us.

This function does not need a url param, it builds it by itself. It also fails-over to the next possible clusters provided by $wgDefaultExternalStore.

Parameters

string	$data
array	$params	Map of ExternalStoreMedium::__construct context parameters

Returns

string The URL of the stored data item

Exceptions

MWException

Deprecated

since 1.34

Definition at line 113 of file ExternalStore.php.

insertToForeignDefault()

static ExternalStore::insertToForeignDefault ( $data, $wiki )

static

Parameters

string	$data
string	$wiki

Returns

string The URL of the stored data item

Exceptions

MWException

Deprecated

since 1.34 Use insertToDefault() with 'wiki' set

Definition at line 143 of file ExternalStore.php.

insertWithFallback()

static ExternalStore::insertWithFallback ( array $tryStores, $data, array $params = [] )

static

Like insert() above, but does more of the work for us.

This function does not need a url param, it builds it by itself. It also fails-over to the next possible clusters as provided in the first parameter.

Parameters

array	$tryStores	Refer to $wgDefaultExternalStore
string	$data
array	$params	Map of ExternalStoreMedium::__construct context parameters

Returns

string The URL of the stored data item

Exceptions

MWException

Deprecated

since 1.34

Definition at line 130 of file ExternalStore.php.

---

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

• includes/externalstore/ExternalStore.php