* Document a bit

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

diff --git a/includes/DatabaseFunctions.php b/includes/DatabaseFunctions.php
index 307e0d9..2df5611 100644 (file)
--- a/includes/DatabaseFunctions.php
+++ b/includes/DatabaseFunctions.php
@@ -2,7 +2,8 @@
 /**
  * Legacy database functions, for compatibility with pre-1.3 code
  * NOTE: this file is no longer loaded by default.
- *
+ * @file
+ * @ingroup Database
  */
 
 /**
@@ -17,7 +18,7 @@ function wfQuery( $sql, $db, $fname = '' ) {
                # Someone has tried to call this the old way
                throw new FatalError( wfMsgNoDB( 'wrong_wfQuery_params', $db, $sql ) );
        }
-       $c =& wfGetDB( $db );
+       $c = wfGetDB( $db );
        if ( $c !== false ) {
                return $c->query( $sql, $fname );
        } else {
@@ -33,7 +34,7 @@ function wfQuery( $sql, $db, $fname = '' ) {
  * @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];
@@ -53,11 +54,11 @@ function wfSingleQuery( $sql, $dbi, $fname = '' ) {
  * @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 {
-               return NULL;
+               return null;
        }
 }
 
@@ -72,7 +73,7 @@ function wfIgnoreSQLErrors( $newstate, $dbi = DB_LAST ) {
  */
 function wfFreeResult( $res, $dbi = DB_LAST )
 {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                $db->freeResult( $res );
                return true;
@@ -86,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 {
@@ -99,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 {
@@ -112,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 {
@@ -125,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 {
@@ -142,7 +143,7 @@ function wfNumFields( $res, $dbi = DB_LAST ) {
  */
 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 {
@@ -153,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 {
@@ -165,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 {
@@ -176,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 {
@@ -188,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 {
@@ -200,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 {
@@ -212,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,7 +241,7 @@ function wfLastDBquery( $dbi = DB_LAST ) {
  */
 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 {
@@ -244,8 +251,8 @@ function wfSetSQL( $table, $var, $value, $cond, $dbi = DB_MASTER )
 
 
 /**
+ * Simple select wrapper, return one field
  * @see Database::selectField()
- * @todo document function
  * @param $table
  * @param $var
  * @param $cond Default ''
@@ -253,7 +260,7 @@ function wfSetSQL( $table, $var, $value, $cond, $dbi = DB_MASTER )
  */
 function wfGetSQL( $table, $var, $cond='', $dbi = DB_LAST )
 {
-       $db =& wfGetDB( $dbi );
+       $db = wfGetDB( $dbi );
        if ( $db !== false ) {
                return $db->selectField( $table, $var, $cond );
        } else {
@@ -262,15 +269,15 @@ function wfGetSQL( $table, $var, $cond='', $dbi = DB_LAST )
 }
 
 /**
+ * Does a given field exist on the specified table?
  * @see Database::fieldExists()
- * @todo document function
  * @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 {
@@ -279,15 +286,15 @@ function wfFieldExists( $table, $field, $dbi = DB_LAST ) {
 }
 
 /**
+ * Does the requested index exist on the specified table?
  * @see Database::indexExists()
- * @todo document function
  * @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 {
@@ -305,7 +312,7 @@ function wfIndexExists( $table, $index, $dbi = DB_LAST ) {
  * @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 {
@@ -324,7 +331,7 @@ function wfInsertArray( $table, $array, $fname = 'wfInsertArray', $dbi = DB_MAST
  * @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 {
@@ -343,7 +350,7 @@ function wfGetArray( $table, $vars, $conds, $fname = 'wfGetArray', $dbi = DB_LAS
  * @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;
@@ -353,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 {
@@ -366,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 {
@@ -378,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 {
@@ -390,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;
        }
 }
-?>