d9ba7cd005
This reduces the odds of having files without corresponding wiki pages, given that the later is done in a deferred update. Also made some documentation cleanups. Bug: T187942 Change-Id: Iff516669f535713d37e0011e2d7ed285c667f1c5
91 lines
2.5 KiB
PHP
91 lines
2.5 KiB
PHP
<?php
|
|
/**
|
|
* External storage in some particular medium.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup ExternalStorage
|
|
*/
|
|
|
|
/**
|
|
* Accessable external objects in a particular storage medium
|
|
*
|
|
* @ingroup ExternalStorage
|
|
* @since 1.21
|
|
*/
|
|
abstract class ExternalStoreMedium {
|
|
/** @var array */
|
|
protected $params = [];
|
|
|
|
/**
|
|
* @param array $params Usage context options:
|
|
* - wiki: the domain ID of the wiki this is being used for [optional]
|
|
*/
|
|
public function __construct( array $params = [] ) {
|
|
$this->params = $params;
|
|
}
|
|
|
|
/**
|
|
* 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 array Map from the url to the text stored. Unfound data is not represented
|
|
*/
|
|
public function batchFetchFromURLs( array $urls ) {
|
|
$retval = [];
|
|
foreach ( $urls as $url ) {
|
|
$data = $this->fetchFromURL( $url );
|
|
// Dont return when false to allow for simpler implementations.
|
|
// errored urls are handled in ExternalStore::batchFetchFromURLs
|
|
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;
|
|
}
|
|
}
|