$this->mParams = $params;
}
- /* Fetch data from given URL */
+ /**
+ * 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 string|bool The text stored or false on error
+ */
static function fetchFromURL( $url, $params = array() ) {
global $wgExternalStores;
if( !$wgExternalStores )
return false;
- @list( $proto, $path ) = explode( '://', $url, 2 );
- /* Bad URL */
- if( $path == '' )
+ $parts = explode( '://', $url, 2 );
+
+ if ( count( $parts ) != 2 ) {
return false;
+ }
+
+ list( $proto, $path ) = $parts;
+
+ if ( $path == '' ) { // Bad URL
+ return false;
+ }
$store = self::getStoreObject( $proto, $params );
if ( $store === false )
/**
* Get an external store object of the given type, with the given parameters
+ *
+ * @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
*/
static function getStoreObject( $proto, $params = array() ) {
global $wgExternalStores;
$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.
- * Returns 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 );
* This function does not need a url param, it builds it by
* itself. It also fails-over to the next possible clusters.
*
- * @param string $data
- * @param array $params Associative array of parameters for the ExternalStore object.
- * Returns the URL of the stored data item, or false on error
+ * @param $data String
+ * @param $storageParams Array: associative array of parameters for the ExternalStore object.
+ * @return string The URL of the stored data item, or false on error
*/
public static function insertToDefault( $data, $storageParams = array() ) {
global $wgDefaultExternalStore;
}
}
- /** 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 ) );
}