<?php
+/**
+ * Data storage in external repositories.
+ *
+ * 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
+ */
+
/**
* @defgroup ExternalStorage ExternalStorage
*/
*/
class ExternalStore {
var $mParams;
-
+
+ /**
+ * @param $params array
+ */
function __construct( $params = array() ) {
$this->mParams = $params;
}
-
+
/**
* Fetch data from given URL
*
* @param $url String: The URL of the text to get
* @param $params Array: associative array of parameters for the ExternalStore object.
- * @return The text stored or false on error
+ * @return string|bool The text stored or false on error
*/
static function fetchFromURL( $url, $params = array() ) {
global $wgExternalStores;
- if( !$wgExternalStores )
+ if( !$wgExternalStores ) {
return false;
+ }
$parts = explode( '://', $url, 2 );
}
$store = self::getStoreObject( $proto, $params );
- if ( $store === false )
+ if ( $store === false ) {
return false;
+ }
+
return $store->fetchFromURL( $url );
}
*
* @param $proto String: type of external storage, should be a value in $wgExternalStores
* @param $params Array: associative array of parameters for the ExternalStore object.
- * @return ExternalStore subclass or false on error
+ * @return ExternalStore|bool ExternalStore class or false on error
*/
static function getStoreObject( $proto, $params = array() ) {
global $wgExternalStores;
- if( !$wgExternalStores )
+ if( !$wgExternalStores ) {
return false;
+ }
+
/* Protocol not enabled */
- if( !in_array( $proto, $wgExternalStores ) )
+ if( !in_array( $proto, $wgExternalStores ) ) {
return false;
+ }
$class = 'ExternalStore' . ucfirst( $proto );
/* Any custom modules should be added to $wgAutoLoadClasses for on-demand loading */
- if( !class_exists( $class ) ) {
+ if( !MWInit::classExists( $class ) ) {
return false;
}
* Store a data item to an external store, identified by a partial URL
* The protocol part is used to identify the class, the rest is passed to the
* class itself as a parameter.
- * @return The URL of the stored data item, or false on error
+ * @param $url
+ * @param $data
+ * @param $params array
+ * @return string|bool The URL of the stored data item, or false on error
*/
static function insert( $url, $data, $params = array() ) {
list( $proto, $params ) = explode( '://', $url, 2 );
return $store->store( $params, $data );
}
}
-
+
/**
* Like insert() above, but does more of the work for us.
* This function does not need a url param, it builds it by
*
* @param $data String
* @param $storageParams Array: associative array of parameters for the ExternalStore object.
- * @return The URL of the stored data item, or false on error
+ * @throws MWException|DBConnectionError|DBQueryError
+ * @return string|bool The URL of the stored data item, or false on error
*/
public static function insertToDefault( $data, $storageParams = array() ) {
global $wgDefaultExternalStore;
throw new MWException( "Unable to store text to external storage" );
}
}
-
- /** Like insertToDefault, but inserts on another wiki */
+
+ /**
+ * @param $data
+ * @param $wiki
+ *
+ * @return string
+ */
public static function insertToForeignDefault( $data, $wiki ) {
return self::insertToDefault( $data, array( 'wiki' => $wiki ) );
}