ExternalStoreMwstore Class Reference

External storage in a FileBackend. More...

Inherits ExternalStoreMedium.

Collaboration diagram for ExternalStoreMwstore:

Public Member Functions
	__construct (array $params)
	batchFetchFromURLs (array $urls)
	Fetch data from given external store URLs.
	fetchFromURL ( $url)
	Fetch data from a given external store URL.
	isReadOnly ( $backend)
	Check if a given location is read-only. Parameters string $location The location name Returns bool Whether this location is read-only Since 1.31
	store ( $backend, $data)
	Insert a data item into a given location. Parameters string $location The location name string $data The data item Returns string|bool The URL of the stored data item, or false on error Exceptions ExternalStoreException
Public Member Functions inherited from ExternalStoreMedium
	setLogger (LoggerInterface $logger)

Additional Inherited Members
Protected Attributes inherited from ExternalStoreMedium
string	$dbDomain
	Default database domain to store content under.
bool	$isDbDomainExplicit
	Whether this was factoried with an explicit DB domain.
LoggerInterface	$logger
array	$params = []
	Usage context options for this instance.

Detailed Description

External storage in a FileBackend.

In this system, each store "location" maps to the name of a file backend. The file backends must be defined in $wgFileBackends and must be global and fully qualified with a global "wikiId" prefix in the configuration.

See also

ExternalStoreAccess

Since

1.21

Definition at line 24 of file ExternalStoreMwstore.php.

Constructor & Destructor Documentation

__construct()

ExternalStoreMwstore::__construct

(

array

$params

)

See also

ExternalStoreMedium::__construct()

Parameters

array

$params

Additional parameters include: fbGroup: a FileBackendGroup instance

Reimplemented from ExternalStoreMedium.

Definition at line 33 of file ExternalStoreMwstore.php.

References ExternalStoreMedium\$params.

Member Function Documentation

batchFetchFromURLs()

ExternalStoreMwstore::batchFetchFromURLs

(

array

$urls

)

Fetch data from given external store URLs.

The URLs are in the form of mwstore://backend/container/wiki/id

Parameters

array

$urls

An array of external store URLs

Returns

array A map from url to stored content. Failed results are not represented.

Reimplemented from ExternalStoreMedium.

Definition at line 66 of file ExternalStoreMwstore.php.

References $url.

fetchFromURL()

ExternalStoreMwstore::fetchFromURL

(

$url

)

Fetch data from a given external store URL.

See also

ExternalStoreMedium::fetchFromURL()

Parameters

string

$url

An external store URL in the form of mwstore://backend/container/wiki/id

Returns

string|bool

Reimplemented from ExternalStoreMedium.

Definition at line 48 of file ExternalStoreMwstore.php.

References $url.

isReadOnly()

ExternalStoreMwstore::isReadOnly

(

$backend

)

Check if a given location is read-only.

Parameters

string

$location

The location name

Returns

bool Whether this location is read-only

Since

1.31

Reimplemented from ExternalStoreMedium.

Definition at line 113 of file ExternalStoreMwstore.php.

store()

ExternalStoreMwstore::store	(		$backend,
			$data )

Insert a data item into a given location.

Parameters

string	$location	The location name
string	$data	The data item

Returns

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

Exceptions

ExternalStoreException

Reimplemented from ExternalStoreMedium.

Definition at line 84 of file ExternalStoreMwstore.php.

References $url.

---

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

• includes/ExternalStore/ExternalStoreMwstore.php