4dcc7961df
Doxygen expects parameter types to come before the parameter name in @param tags. Used a quick regex to switch everything around where possible. This only fixes cases where a primitve variable (or a primitive followed by other types) is the variable type. Other cases will need to be fixed manually. Change-Id: Ic59fd20856eb0489d70f3469a56ebce0efb3db13
60 lines
1.7 KiB
PHP
60 lines
1.7 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
|
|
* @author Aaron Schulz
|
|
*/
|
|
|
|
/**
|
|
* Accessable external objects in a particular storage medium
|
|
*
|
|
* @ingroup ExternalStorage
|
|
* @since 1.21
|
|
*/
|
|
abstract class ExternalStoreMedium {
|
|
/** @var Array */
|
|
protected $params = array();
|
|
|
|
/**
|
|
* @param array $params Options
|
|
*/
|
|
public function __construct( array $params = array() ) {
|
|
$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 );
|
|
|
|
/**
|
|
* 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 );
|
|
}
|