<?php
-# $Id$
-
/**
* Backwards compatibility wrapper for Database.php
*
* Note: $wgDatabase has ceased to exist. Destroy all references.
+ *
+ * @version # $Id$
*/
/**
* 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
*/
-function wfQuery( $sql, $db, $fname = '' )
-{
+function wfQuery( $sql, $db, $fname = '' ) {
global $wgOut;
if ( !is_numeric( $db ) ) {
# Someone has tried to call this the old way
}
}
-function wfSingleQuery( $sql, $dbi, $fname = '' )
-{
+/**
+ *
+ * @param string $sql SQL query
+ * @param $dbi
+ * @param string $fname name of the php function calling
+ * @return array first row from the database
+ */
+function wfSingleQuery( $sql, $dbi, $fname = '' ) {
$db =& wfGetDB( $dbi );
$res = $db->query($sql, $fname );
$row = $db->fetchRow( $res );
return $ret;
}
-function &wfGetDB( $db = DB_LAST )
-{
+/*
+ * @todo document function
+ */
+function &wfGetDB( $db = DB_LAST ) {
global $wgLoadBalancer;
return $wgLoadBalancer->getConnection( $db );
}
-# Turns buffering of SQL result sets on (true) or off (false). Default is
-# "on" and it should not be changed without good reasons.
-# Returns the previous state.
-
-function wfBufferSQLResults( $newstate, $dbi = DB_LAST )
-{
+/**
+ * Turns buffering of SQL result
+ * Sets on (true) or off (false). Default is "on" and it should not be changed
+ * without good reasons.
+ *
+ * @param $newstate
+ * @param $dbi
+ * @return mixed|NULL Returns the previous state.
+*/
+function wfBufferSQLResults( $newstate, $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->setBufferResults( $newstate );
}
}
-# 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
-# database errors. Default is on (false). When turned off, the
-# code should use wfLastErrno() and wfLastError() to handle the
-# situation as appropriate.
-# Returns the previous state.
-
-function wfIgnoreSQLErrors( $newstate, $dbi = DB_LAST )
-{
+/**
+ * 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
+ * database errors. Default is on (false). When turned off, the
+ * code should use wfLastErrno() and wfLastError() to handle the
+ * situation as appropriate.
+ *
+ * @param $newstate
+ * @param $dbi
+ * @return Returns the previous state.
+ */
+function wfIgnoreSQLErrors( $newstate, $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->ignoreErrors( $newstate );
}
}
+/**@#+
+ * @param $res database result handler
+ * @param $dbi
+*/
+
+/**
+ * Free a database result
+ * @return bool whether result is sucessful or not
+ */
function wfFreeResult( $res, $dbi = DB_LAST )
{
$db =& wfGetDB( $dbi );
}
}
-function wfFetchObject( $res, $dbi = DB_LAST )
-{
+/**
+ * Get an object from a database result
+ * @return object|false object we requested
+ */
+function wfFetchObject( $res, $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->fetchObject( $res, $dbi = DB_LAST );
}
}
-function wfFetchRow( $res, $dbi = DB_LAST )
-{
+/**
+ * Get a row from a database result
+ * @return object|false row we requested
+ */
+function wfFetchRow( $res, $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->fetchRow ( $res, $dbi = DB_LAST );
}
}
-function wfNumRows( $res, $dbi = DB_LAST )
-{
+/**
+ * Get a number of rows from a database result
+ * @return integer|false number of rows
+ */
+function wfNumRows( $res, $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->numRows( $res, $dbi = DB_LAST );
}
}
-function wfNumFields( $res, $dbi = DB_LAST )
-{
+/**
+ * Get the number of fields from a database result
+ * @return integer|false number of fields
+ */
+function wfNumFields( $res, $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->numFields( $res );
}
}
+/**
+ * Return name of a field in a result
+ * @param integer $n id of the field
+ * @return string|false name of field
+ */
function wfFieldName( $res, $n, $dbi = DB_LAST )
{
$db =& wfGetDB( $dbi );
return false;
}
}
+/**@#-*/
-function wfInsertId( $dbi = DB_LAST )
-{
+/**
+ * @todo document function
+ */
+function wfInsertId( $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->insertId();
}
}
-function wfDataSeek( $res, $row, $dbi = DB_LAST )
-{
+/**
+ * @todo document function
+ */
+function wfDataSeek( $res, $row, $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->dataSeek( $res, $row );
}
}
-function wfLastErrno( $dbi = DB_LAST )
-{
+/**
+ * @todo document function
+ */
+function wfLastErrno( $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->lastErrno();
}
}
-function wfLastError( $dbi = DB_LAST )
-{
+/**
+ * @todo document function
+ */
+function wfLastError( $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->lastError();
}
}
-function wfAffectedRows( $dbi = DB_LAST )
-{
+/**
+ * @todo document function
+ */
+function wfAffectedRows( $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->affectedRows();
}
}
-function wfLastDBquery( $dbi = DB_LAST )
-{
+/**
+ * @todo document function
+ */
+function wfLastDBquery( $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->lastQuery();
}
}
+/**
+ * @todo document function
+ */
function wfSetSQL( $table, $var, $value, $cond, $dbi = DB_MASTER )
{
$db =& wfGetDB( $dbi );
}
}
+
+/**
+ * @todo document function
+ */
function wfGetSQL( $table, $var, $cond='', $dbi = DB_LAST )
{
$db =& wfGetDB( $dbi );
}
}
-function wfFieldExists( $table, $field, $dbi = DB_LAST )
-{
+/**
+ * @todo document function
+ */
+function wfFieldExists( $table, $field, $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->fieldExists( $table, $field );
}
}
-function wfIndexExists( $table, $index, $dbi = DB_LAST )
-{
+/**
+ * @todo document function
+ */
+function wfIndexExists( $table, $index, $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->indexExists( $table, $index );
}
}
-function wfInsertArray( $table, $array, $fname = 'wfInsertArray', $dbi = DB_MASTER )
-{
+/**
+ * @todo document function
+ */
+function wfInsertArray( $table, $array, $fname = 'wfInsertArray', $dbi = DB_MASTER ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->insertArray( $table, $array, $fname );
}
}
-function wfGetArray( $table, $vars, $conds, $fname = 'wfGetArray', $dbi = DB_LAST )
-{
+/**
+ * @todo document function
+ */
+function wfGetArray( $table, $vars, $conds, $fname = 'wfGetArray', $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->getArray( $table, $vars, $conds, $fname );
}
}
-function wfUpdateArray( $table, $values, $conds, $fname = 'wfUpdateArray', $dbi = DB_MASTER )
-{
+/**
+ * @todo document function
+ */
+function wfUpdateArray( $table, $values, $conds, $fname = 'wfUpdateArray', $dbi = DB_MASTER ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
$db->updateArray( $table, $values, $conds, $fname );
}
}
+/**
+ * @todo document function
+ */
function wfTableName( $name, $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
}
}
-function wfStrencode( $s, $dbi = DB_LAST )
-{
+/**
+ * @todo document function
+ */
+function wfStrencode( $s, $dbi = DB_LAST ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
return $db->strencode( $s );
}
}
+/**
+ * @todo document function
+ */
function wfNextSequenceValue( $seqName, $dbi = DB_MASTER ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {
}
}
+/**
+ * @todo document function
+ */
function wfUseIndexClause( $index, $dbi = DB_SLAVE ) {
$db =& wfGetDB( $dbi );
if ( $db !== false ) {