MediaWiki  1.27.2
ExternalStoreMedium Class Reference

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

Inheritance diagram for ExternalStoreMedium:

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 31 of file ExternalStoreMedium.php.

Constructor & Destructor Documentation

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

Definition at line 38 of file ExternalStoreMedium.php.

References $params.

Member Function Documentation

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

Definition at line 57 of file ExternalStoreMedium.php.

References $retval, as, and 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

Referenced by batchFetchFromURLs().

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

Member Data Documentation

array ExternalStoreMedium::$params = []
protected

Definition at line 33 of file ExternalStoreMedium.php.

Referenced by __construct().


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