MediaWiki  master
ExternalStore Class Reference

Static Public Member Functions

static batchFetchFromURLs (array $urls)
 Fetch data from multiple URLs with a minimum of round trips. More...
 
static fetchFromURL ( $url, array $params=[])
 Fetch data from given URL. More...
 
static getStoreObject ( $proto, array $params=[])
 Get an external store object of the given type, with the given parameters. More...
 
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. More...
 
static insertToDefault ( $data, array $params=[])
 Like insert() above, but does more of the work for us. More...
 
static insertToForeignDefault ( $data, $wiki)
 
static insertWithFallback (array $tryStores, $data, array $params=[])
 Like insert() above, but does more of the work for us. More...
 

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$urlsThe 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$urlThe URL of the text to get
array$paramsAssociative 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$protoType of external storage, should be a value in $wgExternalStores
array$paramsAssociative 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$urlA partial external store URL ("<store type>://<location>")
string$data
array$paramsAssociative 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$paramsMap 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.

Referenced by MigrateArchiveText\doDBUpdates().

◆ 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$tryStoresRefer to $wgDefaultExternalStore
string$data
array$paramsMap 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: