ExternalStoreMedium Class Reference

Base class for external storage. More...

Inheritance diagram for ExternalStoreMedium:

Collaboration diagram for ExternalStoreMedium:

Public Member Functions
	__construct (array $params)
	batchFetchFromURLs (array $urls)
	Fetch data from given external store URLs.
	fetchFromURL ( $url)
	Fetch data from given external store URL.
	isReadOnly ( $location)
	Check if a given location is read-only.
	setLogger (LoggerInterface $logger)
	store ( $location, $data)
	Insert a data item into a given location.

Protected Attributes
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

Base class for external storage.

There can be multiple "locations" for a storage medium type (e.g. DB clusters, filesystems). Blobs are stored under URLs of the form <protocol>://<location>/<path>. Each type of storage medium has an associated protocol.

See also

ExternalStoreAccess

Since

1.21

Definition at line 36 of file ExternalStoreMedium.php.

Constructor & Destructor Documentation

__construct()

ExternalStoreMedium::__construct

(

array

$params

)

Parameters

array

$params

Usage context options for this instance: domain: the DB domain ID of the wiki the content is for [required] logger: LoggerInterface instance [optional] isDomainImplicit: whether this was factoried without an explicit DB domain [optional]

Reimplemented in ExternalStoreDB, and ExternalStoreMwstore.

Definition at line 53 of file ExternalStoreMedium.php.

References $params.

Member Function Documentation

batchFetchFromURLs()

ExternalStoreMedium::batchFetchFromURLs

(

array

$urls

)

Fetch data from given external store URLs.

Parameters

array

$urls

A list of external store URLs

Returns

string[] Map of (url => text) for the URLs where data was actually found

Reimplemented in ExternalStoreDB, ExternalStoreMemory, and ExternalStoreMwstore.

Definition at line 84 of file ExternalStoreMedium.php.

References fetchFromURL().

fetchFromURL()

ExternalStoreMedium::fetchFromURL ( $url )

abstract

Fetch data from given external store URL.

Parameters

string

$url

An external store URL

Returns

string|bool The text stored or false on error

Exceptions

MWException

Reimplemented in ExternalStoreDB, ExternalStoreHttp, ExternalStoreMemory, and ExternalStoreMwstore.

Referenced by batchFetchFromURLs().

isReadOnly()

ExternalStoreMedium::isReadOnly

(

$location

)

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 in ExternalStoreMwstore, ExternalStoreDB, and ExternalStoreHttp.

Definition at line 114 of file ExternalStoreMedium.php.

setLogger()

ExternalStoreMedium::setLogger

(

LoggerInterface

$logger

)

Definition at line 65 of file ExternalStoreMedium.php.

References $logger.

store()

ExternalStoreMedium::store ( $location, $data )

abstract

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

MWException

Reimplemented in ExternalStoreMwstore, ExternalStoreDB, ExternalStoreHttp, and ExternalStoreMemory.

Member Data Documentation

$dbDomain

string ExternalStoreMedium::$dbDomain

protected

Default database domain to store content under.

Definition at line 40 of file ExternalStoreMedium.php.

Referenced by ExternalStoreMemory\fetchFromURL(), and ExternalStoreMemory\store().

$isDbDomainExplicit

bool ExternalStoreMedium::$isDbDomainExplicit

protected

Whether this was factoried with an explicit DB domain.

Definition at line 42 of file ExternalStoreMedium.php.

$logger

LoggerInterface ExternalStoreMedium::$logger

protected

Definition at line 45 of file ExternalStoreMedium.php.

Referenced by setLogger().

$params

array ExternalStoreMedium::$params = []

protected

Usage context options for this instance.

Definition at line 38 of file ExternalStoreMedium.php.

Referenced by ExternalStoreDB\__construct(), __construct(), and ExternalStoreMwstore\__construct().

---

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

• includes/externalstore/ExternalStoreMedium.php