<?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 {
+ } else {
return false;
}
}
/**
*
- * @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];
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
* @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;
}
}
/**#@+
- * @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 );
+function wfFreeResult( $res, $dbi = DB_LAST )
+{
+ $db = wfGetDB( $dbi );
if ( $db !== false ) {
- $db->freeResult( $res );
+ $db->freeResult( $res );
return true;
- } else {
+ } else {
return false;
}
}
* Get an object from a database result
* @return object|false object we requested
*/
-function wfFetchObject( $res, $dbi = DB_LAST ) {
- $db =& wfGetDB( $dbi );
+function wfFetchObject( $res, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
if ( $db !== false ) {
- return $db->fetchObject( $res, $dbi = DB_LAST );
- } else {
+ return $db->fetchObject( $res, $dbi = DB_LAST );
+ } else {
return false;
}
}
* @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 {
+ } else {
return false;
}
}
* Get a number of rows from a database result
* @return integer|false number of rows
*/
-function wfNumRows( $res, $dbi = DB_LAST ) {
- $db =& wfGetDB( $dbi );
+function wfNumRows( $res, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
if ( $db !== false ) {
- return $db->numRows( $res, $dbi = DB_LAST );
- } else {
+ return $db->numRows( $res, $dbi = DB_LAST );
+ } else {
return false;
}
}
* Get the number of fields from a database result
* @return integer|false number of fields
*/
-function wfNumFields( $res, $dbi = DB_LAST ) {
- $db =& wfGetDB( $dbi );
+function wfNumFields( $res, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
if ( $db !== false ) {
- return $db->numFields( $res );
- } else {
+ return $db->numFields( $res );
+ } else {
return false;
}
}
/**
* 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 );
+function wfFieldName( $res, $n, $dbi = DB_LAST )
+{
+ $db = wfGetDB( $dbi );
if ( $db !== false ) {
- return $db->fieldName( $res, $n, $dbi = DB_LAST );
- } else {
+ return $db->fieldName( $res, $n, $dbi = DB_LAST );
+ } else {
return false;
}
}
/**
* @todo document function
+ * @see Database::insertId()
*/
-function wfInsertId( $dbi = DB_LAST ) {
- $db =& wfGetDB( $dbi );
+function wfInsertId( $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
if ( $db !== false ) {
- return $db->insertId();
- } else {
+ return $db->insertId();
+ } else {
return false;
}
}
/**
* @todo document function
+ * @see Database::dataSeek()
*/
-function wfDataSeek( $res, $row, $dbi = DB_LAST ) {
- $db =& wfGetDB( $dbi );
+function wfDataSeek( $res, $row, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
if ( $db !== false ) {
- return $db->dataSeek( $res, $row );
- } else {
+ return $db->dataSeek( $res, $row );
+ } else {
return false;
}
}
/**
- * @todo document function
+ * Get the last error number
+ * @see Database::lastErrno()
*/
-function wfLastErrno( $dbi = DB_LAST ) {
- $db =& wfGetDB( $dbi );
+function wfLastErrno( $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
if ( $db !== false ) {
- return $db->lastErrno();
- } else {
+ return $db->lastErrno();
+ } else {
return false;
}
}
/**
- * @todo document function
+ * Get the last error
+ * @see Database::lastError()
*/
-function wfLastError( $dbi = DB_LAST ) {
- $db =& wfGetDB( $dbi );
+function wfLastError( $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
if ( $db !== false ) {
- return $db->lastError();
- } else {
+ return $db->lastError();
+ } else {
return false;
}
}
/**
- * @todo document function
+ * Get the number of affected rows
+ * @see Database::affectedRows()
*/
-function wfAffectedRows( $dbi = DB_LAST ) {
- $db =& wfGetDB( $dbi );
+function wfAffectedRows( $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
if ( $db !== false ) {
- return $db->affectedRows();
- } else {
+ return $db->affectedRows();
+ } else {
return false;
}
}
/**
- * @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 {
+ } else {
return false;
}
}
/**
+ * @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 {
+ } else {
return false;
}
}
/**
- * @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 {
+ } else {
return false;
}
}
/**
- * @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 {
+ } else {
return false;
}
}
/**
- * @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 {
+ } else {
return false;
}
}
/**
+ * @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 {
+ } else {
return false;
}
}
/**
+ * @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 {
+ } else {
return false;
}
}
/**
+ * @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;
}
/**
- * @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 {
/**
* @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 {
/**
* @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 {
/**
* @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;
}
}
-?>
scripts.mit.edu / autoinstalls / mediawiki.git / blobdiff