Add a way for packagers to override some installation details

[lhc/web/wiklou.git] / includes / ExternalStore.php

diff --git a/includes/ExternalStore.php b/includes/ExternalStore.php
index d759d67..61d4ef7 100644 (file)
--- a/includes/ExternalStore.php
+++ b/includes/ExternalStore.php
@@ -1,4 +1,25 @@
 <?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
  */
@@ -19,17 +40,30 @@ class ExternalStore {
                $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 )
@@ -39,6 +73,10 @@ class ExternalStore {
 
        /**
         * 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;
@@ -50,7 +88,7 @@ class ExternalStore {
 
                $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;
                }
 
@@ -61,7 +99,10 @@ class ExternalStore {
         * 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 );
@@ -78,9 +119,9 @@ class ExternalStore {
         * 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;
@@ -119,7 +160,12 @@ class ExternalStore {
                }
        }
        
-       /** 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 ) );
        }