includes/externalstore/ExternalStoreMedium.php

   1 <?php
   2 /**
   3  * External storage in some particular medium.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup ExternalStorage
  22  * @author Aaron Schulz
  23  */
  24
  25 /**
  26  * Accessable external objects
  27  * @ingroup ExternalStorage
  28  */
  29 abstract class ExternalStoreMedium {
  30         /** @var Array */
  31         protected $params = array();
  32
  33         /**
  34          * @param $params array Options
  35          */
  36         public function __construct( array $params = array() ) {
  37                 $this->params = $params;
  38         }
  39
  40         /**
  41          * Fetch data from given external store URL
  42          *
  43          * @param $url string An external store URL
  44          * @return string|bool The text stored or false on error
  45          * @throws MWException
  46          */
  47         public abstract function fetchFromURL( $url );
  48
  49         /**
  50          * Insert a data item into a given location
  51          *
  52          * @param $location string: the location name
  53          * @param $data string: the data item
  54          * @return string|bool The URL of the stored data item, or false on error
  55          * @throws MWException
  56          */
  57         public abstract function store( $location, $data );
  58 }