ExternalStore Class Reference

Constructor class for data kept in external repositories. More...

List of all members.

Public Member Functions
	__construct ($params=array())
Static Public Member Functions
static	fetchFromURL ($url, $params=array())
	Fetch data from given URL.
static	getStoreObject ($proto, $params=array())
	Get an external store object of the given type, with the given parameters.
static	insert ($url, $data, $params=array())
	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, $storageParams=array())
	Like insert() above, but does more of the work for us.
static	insertToForeignDefault ($data, $wiki)
Public Attributes
	$mParams

---

Detailed Description

Constructor class for data kept in external repositories.

External repositories might be populated by maintenance/async scripts, thus partial moving of data may be possible, as well as possibility to have any storage format (i.e. for archives)

Definition at line 36 of file ExternalStore.php.

---

Constructor & Destructor Documentation

ExternalStore::__construct

(

$

params = array()

)

Parameters:

$params

array

Definition at line 42 of file ExternalStore.php.

References $params.

---

Member Function Documentation

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

Fetch data from given URL.

Parameters:

$url	String: The URL of the text to get
$params	Array: associative array of parameters for the ExternalStore object.

Returns:

string|bool The text stored or false on error

Definition at line 53 of file ExternalStore.php.

References $params, $path, $url, getStoreObject(), global, and list.

Referenced by DumpRev\execute(), FixBug20757\execute(), and ExternalStoreTest\testExternalFetchFromURL().

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

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

Parameters:

$proto	String: type of external storage, should be a value in $wgExternalStores
$params	Array: associative array of parameters for the ExternalStore object.

Returns:

ExternalStore|bool ExternalStore class or false on error

Definition at line 87 of file ExternalStore.php.

References $params, MWInit\classExists(), and global.

Referenced by DumpRev\execute(), fetchFromURL(), insert(), and insertToDefault().

static ExternalStore::insert	(	$	url,
		$	data,
		$	params = array()
	)		[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:

$url
$data
$params	array

Returns:

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

Definition at line 116 of file ExternalStore.php.

References $params, $url, getStoreObject(), and list.

static ExternalStore::insertToDefault	(	$	data,
		$	storageParams = array()
	)		[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.

Parameters:

$data	String
$storageParams	Array: associative array of parameters for the ExternalStore object.

Exceptions:

MWException|DBConnectionError|DBQueryError

Returns:

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

Definition at line 136 of file ExternalStore.php.

References $error, $params, $url, array(), getStoreObject(), global, list, wfDebug(), and wfDebugLog().

Referenced by insertToForeignDefault().

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

Parameters:

$data
$wiki

Returns:

string

Definition at line 179 of file ExternalStore.php.

References array(), and insertToDefault().

---

Member Data Documentation

ExternalStore::$mParams

Definition at line 37 of file ExternalStore.php.

---

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

• includes/ExternalStore.php