File backend accessible external objects. More...
Public Member Functions | |||||||||
| __construct (array $params) | |||||||||
| batchFetchFromURLs (array $urls) | |||||||||
| Fetch data from given external store URLs. More... | |||||||||
| fetchFromURL ( $url) | |||||||||
| The URL returned is of the form of the form mwstore://backend/container/wiki/id. More... | |||||||||
| isReadOnly ( $backend) | |||||||||
| Check if a given location is read-only. More... | |||||||||
| store ( $backend, $data) | |||||||||
Insert a data item into a given location.
| |||||||||
 Public Member Functions inherited from ExternalStoreMedium | |||||||||
| setLogger (LoggerInterface $logger) | |||||||||
Private Attributes | |
| FileBackendGroup | $fbGroup |
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
File backend accessible external objects.
In this system, each store "location" maps to the name of a file backend. The file backends must be defined in $wgFileBackends and must be global and fully qualified with a global "wikiId" prefix in the configuration.
- Since
- 1.21
Definition at line 33 of file ExternalStoreMwstore.php.
Constructor & Destructor Documentation
◆ __construct()
| ExternalStoreMwstore::__construct | ( | array | $params | ) |
- Parameters
-
array $params Additional parameters include: - fbGroup: a FileBackendGroup instance
Reimplemented from ExternalStoreMedium.
Definition at line 42 of file ExternalStoreMwstore.php.
References ExternalStoreMedium\$params.
Member Function Documentation
◆ batchFetchFromURLs()
| ExternalStoreMwstore::batchFetchFromURLs | ( | array | $urls | ) |
Fetch data from given external store URLs.
The URL returned is of the form of the form mwstore://backend/container/wiki/id
- Parameters
-
array $urls An array of external store URLs
- Returns
- array A map from url to stored content. Failed results are not represented.
Reimplemented from ExternalStoreMedium.
Definition at line 75 of file ExternalStoreMwstore.php.
◆ fetchFromURL()
| ExternalStoreMwstore::fetchFromURL | ( | $url | ) |
The URL returned is of the form of the form mwstore://backend/container/wiki/id.
- Parameters
-
string $url
- Returns
- bool
Reimplemented from ExternalStoreMedium.
Definition at line 57 of file ExternalStoreMwstore.php.
◆ isReadOnly()
| ExternalStoreMwstore::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 from ExternalStoreMedium.
Definition at line 122 of file ExternalStoreMwstore.php.
◆ store()
| ExternalStoreMwstore::store | ( | $backend, | |
| $data | |||
| ) |
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 from ExternalStoreMedium.
Definition at line 95 of file ExternalStoreMwstore.php.
References $status, WikiMap\getWikiIdFromDbDomain(), and UIDGenerator\newTimestampedUID128().
Member Data Documentation
◆ $fbGroup
|
private |
Definition at line 35 of file ExternalStoreMwstore.php.
The documentation for this class was generated from the following file:
- includes/externalstore/ExternalStoreMwstore.php
