ExternalStoreHttp Class Reference
External storage using HTTP requests. More...
Inherits ExternalStoreMedium.
Collaboration diagram for ExternalStoreHttp:
Public Member Functions | |
| fetchFromURL ( $url) | |
| Fetch data from given external store URL. | |
| isReadOnly ( $location) | |
| Check if a given location is read-only. | |
| store ( $location, $data) | |
| Insert a data item into a given location. | |
 Public Member Functions inherited from ExternalStoreMedium | |
| __construct (array $params) | |
| batchFetchFromURLs (array $urls) | |
| Fetch data from given external store URLs. | |
| setLogger (LoggerInterface $logger) | |
Additional Inherited Members | |
| Protected Attributes inherited from ExternalStoreMedium | |
| string | $dbDomain |
| Default database domain to store content under. | |
| bool | $isDbDomainExplicit |
| Whether this was factoried with an explicit DB domain. | |
| LoggerInterface | $logger |
| array | $params = [] |
| Usage context options for this instance. | |
Detailed Description
External storage using HTTP requests.
Example class for HTTP accessible external objects. Only supports reading, not storing.
- See also
- ExternalStoreAccess
Definition at line 32 of file ExternalStoreHttp.php.
Member Function Documentation
◆ fetchFromURL()
| ExternalStoreHttp::fetchFromURL | ( | $url | ) |
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
-
ExternalStoreException
Reimplemented from ExternalStoreMedium.
Definition at line 33 of file ExternalStoreHttp.php.
◆ isReadOnly()
| ExternalStoreHttp::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 43 of file ExternalStoreHttp.php.
◆ store()
| ExternalStoreHttp::store | ( | $location, | |
| $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
-
ExternalStoreException
Reimplemented from ExternalStoreMedium.
Definition at line 38 of file ExternalStoreHttp.php.
The documentation for this class was generated from the following file:
- includes/externalstore/ExternalStoreHttp.php
