ExternalStoreMedium Class Reference
Accessable external objects in a particular storage medium. More...
Inheritance diagram for ExternalStoreMedium:
Collaboration diagram for ExternalStoreMedium:
Public Member Functions | |
| __construct (array $params=array()) | |
| batchFetchFromURLs (array $urls) | |
| Fetch data from given external store URLs. | |
| fetchFromURL ($url) | |
| Fetch data from given external store URL. | |
| store ($location, $data) | |
| Insert a data item into a given location. | |
Protected Attributes | |
| Array | $params = array() |
| * | |
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 = array() | ) |
- Parameters:
-
array $params Options
Definition at line 37 of file ExternalStoreMedium.php.
Member Function Documentation
| ExternalStoreMedium::batchFetchFromURLs | ( | array $ | urls | ) |
Fetch data from given external store URLs.
- Parameters:
-
array $urls A 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.
| 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 ExternalStoreMwstore, ExternalStoreDB, and ExternalStoreHttp.
| 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 ExternalStoreDB, ExternalStoreMwstore, and ExternalStoreHttp.
Member Data Documentation
Array ExternalStoreMedium::$params = array() [protected] |
*
Definition at line 32 of file ExternalStoreMedium.php.
The documentation for this class was generated from the following file:
- includes/externalstore/ExternalStoreMedium.php
