Minor documentation tweaks/improvements

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

diff --git a/includes/ExternalStore.php b/includes/ExternalStore.php
index d759d67..ddb40c3 100644 (file)
--- a/includes/ExternalStore.php
+++ b/includes/ExternalStore.php
@@ -19,17 +19,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 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 +52,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;
@@ -61,7 +78,7 @@ 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
+        * @return 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 +95,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 The URL of the stored data item, or false on error
         */
        public static function insertToDefault( $data, $storageParams = array() ) {
                global $wgDefaultExternalStore;