MediaWiki  1.30.2
Public Member Functions | Protected Attributes | List of all members
ExternalStoreMedium Class Reference
ExternalStorage

Accessable external objects in a particular storage medium. More...

Inheritance diagram for ExternalStoreMedium:
Inheritance graph
[legend]

Public Member Functions

 __construct (array $params=[])
 
 batchFetchFromURLs (array $urls)
 Fetch data from given external store URLs. More...
 
 fetchFromURL ( $url)
 Fetch data from given external store URL. More...
 
 store ( $location, $data)
 Insert a data item into a given location. More...
 

Protected Attributes

array $params = []
 

Detailed Description

Accessable external objects in a particular storage medium.

Since
1.21

Definition at line 30 of file ExternalStoreMedium.php.

Constructor & Destructor Documentation

◆ __construct()

ExternalStoreMedium::__construct ( array  $params = [])
Parameters
array$paramsOptions

Definition at line 37 of file ExternalStoreMedium.php.

References $params.

Member Function Documentation

◆ batchFetchFromURLs()

ExternalStoreMedium::batchFetchFromURLs ( array  $urls)

Fetch data from given external store URLs.

Parameters
array$urlsA list of external store URLs
Returns
array Map from the url to the text stored. Unfound data is not represented

Reimplemented in ExternalStoreDB, and ExternalStoreMwstore.

Definition at line 56 of file ExternalStoreMedium.php.

References $retval, as, and fetchFromURL().

◆ fetchFromURL()

ExternalStoreMedium::fetchFromURL (   $url)
abstract

Fetch data from given external store URL.

Parameters
string$urlAn external store URL
Returns
string|bool The text stored or false on error
Exceptions
MWException

Reimplemented in ExternalStoreDB, ExternalStoreMwstore, and ExternalStoreHttp.

Referenced by batchFetchFromURLs().

◆ store()

ExternalStoreMedium::store (   $location,
  $data 
)
abstract

Insert a data item into a given location.

Parameters
string$locationThe location name
string$dataThe data item
Returns
string|bool The URL of the stored data item, or false on error
Exceptions
MWException

Reimplemented in ExternalStoreDB, ExternalStoreHttp, and ExternalStoreMwstore.

Member Data Documentation

◆ $params

array ExternalStoreMedium::$params = []
protected

Definition at line 32 of file ExternalStoreMedium.php.

Referenced by __construct().

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