MediaWiki  master
ExternalStoreHttp Class Reference

Example class for HTTP accessible external objects. More...

Inheritance diagram for ExternalStoreHttp:
Collaboration diagram for ExternalStoreHttp:

Public Member Functions

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

Additional Inherited Members

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

Detailed Description

Example class for HTTP accessible external objects.

Only supports reading, not storing.

Definition at line 31 of file ExternalStoreHttp.php.

Member Function Documentation

◆ fetchFromURL()

ExternalStoreHttp::fetchFromURL (   $url)

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 from ExternalStoreMedium.

Definition at line 32 of file ExternalStoreHttp.php.

◆ isReadOnly()

ExternalStoreHttp::isReadOnly (   $location)

Check if a given location is read-only.

Parameters
string$locationThe location name
Returns
bool Whether this location is read-only
Since
1.31

Reimplemented from ExternalStoreMedium.

Definition at line 41 of file ExternalStoreHttp.php.

◆ store()

ExternalStoreHttp::store (   $location,
  $data 
)

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 from ExternalStoreMedium.

Definition at line 37 of file ExternalStoreHttp.php.


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