Bugfis, making ?uselang=qqq an invalid language code, see

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

diff --git a/includes/DatabaseFunctions.php b/includes/DatabaseFunctions.php
index 0618950..52e9a8c 100644 (file)
--- a/includes/DatabaseFunctions.php
+++ b/includes/DatabaseFunctions.php
@@ -1,26 +1,24 @@
 <?php
 /**
- * Backwards compatibility wrapper for Database.php
- *
- * Note: $wgDatabase has ceased to exist. Destroy all references.
- *
- * @package MediaWiki
+ * Legacy database functions, for compatibility with pre-1.3 code
+ * NOTE: this file is no longer loaded by default.
+ * @file
+ * @ingroup Database
  */
 
 /**
  * Usually aborts on failure
  * If errors are explicitly ignored, returns success
- * @param string $sql SQL query
- * @param mixed $db database handler
- * @param string $fname name of the php function calling
+ * @param $sql String: SQL query
+ * @param $db Mixed: database handler
+ * @param $fname String: name of the php function calling
  */
 function wfQuery( $sql, $db, $fname = '' ) {
-       global $wgOut;
        if ( !is_numeric( $db ) ) {
                # Someone has tried to call this the old way
-               $wgOut->fatalError( wfMsgNoDB( 'wrong_wfQuery_params', $db, $sql ) );
+               throw new FatalError( wfMsgNoDB( 'wrong_wfQuery_params', $db, $sql ) );
        }
-       $c =& wfGetDB( $db );
+       $c = wfGetDB( $db );
        if ( $c !== false ) {
                return $c->query( $sql, $fname );
        } else {
@@ -30,13 +28,13 @@ function wfQuery( $sql, $db, $fname = '' ) {
 
 /**
  *
- * @param string $sql SQL query
+ * @param $sql String: SQL query
  * @param $dbi
- * @param string $fname name of the php function calling
- * @return array first row from the database
+ * @param $fname String: name of the php function calling
+ * @return Array: first row from the database
  */
 function wfSingleQuery( $sql, $dbi, $fname = '' ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        $res = $db->query($sql, $fname );
        $row = $db->fetchRow( $res );
        $ret = $row[0];
@@ -44,15 +42,6 @@ function wfSingleQuery( $sql, $dbi, $fname = '' ) {
        return $ret;
 }
 
-/*
- * @todo document function
- */
-function &wfGetDB( $db = DB_LAST, $groups = array() ) {
-       global $wgLoadBalancer;
-       $ret =& $wgLoadBalancer->getConnection( $db, true, $groups );
-       return $ret;
-}
-
 /**
  * Turns on (false) or off (true) the automatic generation and sending
  * of a "we're sorry, but there has been a database error" page on
@@ -65,7 +54,7 @@ function &wfGetDB( $db = DB_LAST, $groups = array() ) {
  * @return Returns the previous state.
  */
 function wfIgnoreSQLErrors( $newstate, $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->ignoreErrors( $newstate );
        } else {
@@ -74,17 +63,17 @@ function wfIgnoreSQLErrors( $newstate, $dbi = DB_LAST ) {
 }
 
 /**#@+
- * @param $res database result handler
+ * @param $res Database result handler
  * @param $dbi
 */
 
 /**
  * Free a database result
- * @return bool whether result is sucessful or not
+ * @return Bool: whether result is sucessful or not.
  */
 function wfFreeResult( $res, $dbi = DB_LAST )
 {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                $db->freeResult( $res );
                return true;
@@ -98,7 +87,7 @@ function wfFreeResult( $res, $dbi = DB_LAST )
  * @return object|false object we requested
  */
 function wfFetchObject( $res, $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->fetchObject( $res, $dbi = DB_LAST );
        } else {
@@ -111,7 +100,7 @@ function wfFetchObject( $res, $dbi = DB_LAST ) {
  * @return object|false row we requested
  */
 function wfFetchRow( $res, $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->fetchRow ( $res, $dbi = DB_LAST );
        } else {
@@ -124,7 +113,7 @@ function wfFetchRow( $res, $dbi = DB_LAST ) {
  * @return integer|false number of rows
  */
 function wfNumRows( $res, $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->numRows( $res, $dbi = DB_LAST );
        } else {
@@ -137,7 +126,7 @@ function wfNumRows( $res, $dbi = DB_LAST ) {
  * @return integer|false number of fields
  */
 function wfNumFields( $res, $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->numFields( $res );
        } else {
@@ -147,12 +136,14 @@ function wfNumFields( $res, $dbi = DB_LAST ) {
 
 /**
  * Return name of a field in a result
- * @param integer $n id of the field
+ * @param $res Mixed: Ressource link see Database::fieldName()
+ * @param $n Integer: id of the field
+ * @param $dbi Default DB_LAST
  * @return string|false name of field
  */
 function wfFieldName( $res, $n, $dbi = DB_LAST )
 {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->fieldName( $res, $n, $dbi = DB_LAST );
        } else {
@@ -163,9 +154,10 @@ function wfFieldName( $res, $n, $dbi = DB_LAST )
 
 /**
  * @todo document function
+ * @see Database::insertId()
  */
 function wfInsertId( $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->insertId();
        } else {
@@ -175,9 +167,10 @@ function wfInsertId( $dbi = DB_LAST ) {
 
 /**
  * @todo document function
+ * @see Database::dataSeek()
  */
 function wfDataSeek( $res, $row, $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->dataSeek( $res, $row );
        } else {
@@ -186,10 +179,11 @@ function wfDataSeek( $res, $row, $dbi = DB_LAST ) {
 }
 
 /**
- * @todo document function
+ * Get the last error number
+ * @see Database::lastErrno()
  */
 function wfLastErrno( $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->lastErrno();
        } else {
@@ -198,10 +192,11 @@ function wfLastErrno( $dbi = DB_LAST ) {
 }
 
 /**
- * @todo document function
+ * Get the last error
+ * @see Database::lastError()
  */
 function wfLastError( $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->lastError();
        } else {
@@ -210,10 +205,11 @@ function wfLastError( $dbi = DB_LAST ) {
 }
 
 /**
- * @todo document function
+ * Get the number of affected rows
+ * @see Database::affectedRows()
  */
 function wfAffectedRows( $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->affectedRows();
        } else {
@@ -222,10 +218,11 @@ function wfAffectedRows( $dbi = DB_LAST ) {
 }
 
 /**
- * @todo document function
+ * Get the last query ran
+ * @see Database::lastQuery
  */
 function wfLastDBquery( $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->lastQuery();
        } else {
@@ -234,11 +231,17 @@ function wfLastDBquery( $dbi = DB_LAST ) {
 }
 
 /**
+ * @see Database::Set()
  * @todo document function
+ * @param $table
+ * @param $var
+ * @param $value
+ * @param $cond
+ * @param $dbi Default DB_MASTER
  */
 function wfSetSQL( $table, $var, $value, $cond, $dbi = DB_MASTER )
 {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->set( $table, $var, $value, $cond );
        } else {
@@ -248,11 +251,16 @@ function wfSetSQL( $table, $var, $value, $cond, $dbi = DB_MASTER )
 
 
 /**
- * @todo document function
+ * Simple select wrapper, return one field
+ * @see Database::selectField()
+ * @param $table
+ * @param $var
+ * @param $cond Default ''
+ * @param $dbi Default DB_LAST
  */
 function wfGetSQL( $table, $var, $cond='', $dbi = DB_LAST )
 {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->selectField( $table, $var, $cond );
        } else {
@@ -261,10 +269,15 @@ function wfGetSQL( $table, $var, $cond='', $dbi = DB_LAST )
 }
 
 /**
- * @todo document function
+ * Does a given field exist on the specified table?
+ * @see Database::fieldExists()
+ * @param $table
+ * @param $field
+ * @param $dbi Default DB_LAST
+ * @return Result of Database::fieldExists() or false.
  */
 function wfFieldExists( $table, $field, $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->fieldExists( $table, $field );
        } else {
@@ -273,10 +286,15 @@ function wfFieldExists( $table, $field, $dbi = DB_LAST ) {
 }
 
 /**
- * @todo document function
+ * Does the requested index exist on the specified table?
+ * @see Database::indexExists()
+ * @param $table String
+ * @param $index
+ * @param $dbi Default DB_LAST
+ * @return Result of Database::indexExists() or false.
  */
 function wfIndexExists( $table, $index, $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->indexExists( $table, $index );
        } else {
@@ -285,10 +303,16 @@ function wfIndexExists( $table, $index, $dbi = DB_LAST ) {
 }
 
 /**
+ * @see Database::insert()
  * @todo document function
+ * @param $table String
+ * @param $array Array
+ * @param $fname String, default 'wfInsertArray'.
+ * @param $dbi Default DB_MASTER
+ * @return result of Database::insert() or false.
  */
 function wfInsertArray( $table, $array, $fname = 'wfInsertArray', $dbi = DB_MASTER ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->insert( $table, $array, $fname );
        } else {
@@ -297,10 +321,17 @@ function wfInsertArray( $table, $array, $fname = 'wfInsertArray', $dbi = DB_MAST
 }
 
 /**
+ * @see Database::getArray()
  * @todo document function
+ * @param $table String
+ * @param $vars
+ * @param $conds
+ * @param $fname String, default 'wfGetArray'.
+ * @param $dbi Default DB_LAST
+ * @return result of Database::getArray() or false.
  */
 function wfGetArray( $table, $vars, $conds, $fname = 'wfGetArray', $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->getArray( $table, $vars, $conds, $fname );
        } else {
@@ -309,10 +340,17 @@ function wfGetArray( $table, $vars, $conds, $fname = 'wfGetArray', $dbi = DB_LAS
 }
 
 /**
+ * @see Database::update()
+ * @param $table String
+ * @param $values
+ * @param $conds
+ * @param $fname String, default 'wfUpdateArray'
+ * @param $dbi Default DB_MASTER
+ * @return Result of Database::update()) or false;
  * @todo document function
  */
 function wfUpdateArray( $table, $values, $conds, $fname = 'wfUpdateArray', $dbi = DB_MASTER ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                $db->update( $table, $values, $conds, $fname );
                return true;
@@ -322,10 +360,11 @@ function wfUpdateArray( $table, $values, $conds, $fname = 'wfUpdateArray', $dbi
 }
 
 /**
- * @todo document function
+ * Get fully usable table name
+ * @see Database::tableName()
  */
 function wfTableName( $name, $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->tableName( $name );
        } else {
@@ -335,9 +374,10 @@ function wfTableName( $name, $dbi = DB_LAST ) {
 
 /**
  * @todo document function
+ * @see Database::strencode()
  */
 function wfStrencode( $s, $dbi = DB_LAST ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->strencode( $s );
        } else {
@@ -347,9 +387,10 @@ function wfStrencode( $s, $dbi = DB_LAST ) {
 
 /**
  * @todo document function
+ * @see Database::nextSequenceValue()
  */
 function wfNextSequenceValue( $seqName, $dbi = DB_MASTER ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->nextSequenceValue( $seqName );
        } else {
@@ -359,13 +400,13 @@ function wfNextSequenceValue( $seqName, $dbi = DB_MASTER ) {
 
 /**
  * @todo document function
+ * @see Database::useIndexClause()
  */
 function wfUseIndexClause( $index, $dbi = DB_SLAVE ) {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->useIndexClause( $index );
        } else {
                return false;
        }
 }
-?>