:///`. Each type of storage * medium has an associated protocol. * * @see ExternalStoreAccess * @ingroup ExternalStorage * @since 1.21 */ abstract class ExternalStoreMedium implements LoggerAwareInterface { /** @var array Usage context options for this instance */ protected $params = []; /** @var string Default database domain to store content under */ protected $dbDomain; /** @var bool Whether this was factoried with an explicit DB domain */ protected $isDbDomainExplicit; /** @var LoggerInterface */ protected $logger; /** * @param array $params Usage context options for this instance: * - domain: the DB domain ID of the wiki the content is for [required] * - logger: LoggerInterface instance [optional] * - isDomainImplicit: whether this was factoried without an explicit DB domain [optional] */ public function __construct( array $params ) { $this->params = $params; if ( isset( $params['domain'] ) ) { $this->dbDomain = $params['domain']; $this->isDbDomainExplicit = empty( $params['isDomainImplicit'] ); } else { throw new InvalidArgumentException( 'Missing DB "domain" parameter.' ); } $this->logger = $params['logger'] ?? new NullLogger(); } public function setLogger( LoggerInterface $logger ) { $this->logger = $logger; } /** * Fetch data from given external store URL * * @param string $url An external store URL * @return string|bool The text stored or false on error * @throws MWException */ abstract public function fetchFromURL( $url ); /** * Fetch data from given external store URLs. * * @param array $urls A list of external store URLs * @return string[] Map of (url => text) for the URLs where data was actually found */ public function batchFetchFromURLs( array $urls ) { $retval = []; foreach ( $urls as $url ) { $data = $this->fetchFromURL( $url ); // Dont return when false to allow for simpler implementations if ( $data !== false ) { $retval[$url] = $data; } } return $retval; } /** * Insert a data item into a given location * * @param string $location The location name * @param string $data The data item * @return string|bool The URL of the stored data item, or false on error * @throws MWException */ abstract public function store( $location, $data ); /** * Check if a given location is read-only * * @param string $location The location name * @return bool Whether this location is read-only * @since 1.31 */ public function isReadOnly( $location ) { return false; } }