From 4720e1d4e38a07ad011a3f1fca26a7edd6243a1e Mon Sep 17 00:00:00 2001 From: Sam Reed Date: Fri, 1 Jul 2011 02:57:31 +0000 Subject: [PATCH] Add documentation Trim trailing whitespace --- includes/db/Database.php | 357 +++++++++++++++++++++------------------ 1 file changed, 189 insertions(+), 168 deletions(-) diff --git a/includes/db/Database.php b/includes/db/Database.php index c5ae9468dc..74fe86bfe3 100644 --- a/includes/db/Database.php +++ b/includes/db/Database.php @@ -241,7 +241,7 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Boolean, controls output of large amounts of debug information. + * Boolean, controls output of large amounts of debug information. * @param $debug: * - true to enable debugging * - false to disable debugging @@ -254,23 +254,25 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Turns buffering of SQL result sets on (true) or off (false). Default is - * "on". + * Turns buffering of SQL result sets on (true) or off (false). Default is + * "on". * * Unbuffered queries are very troublesome in MySQL: * - * - If another query is executed while the first query is being read + * - If another query is executed while the first query is being read * out, the first query is killed. This means you can't call normal * MediaWiki functions while you are reading an unbuffered query result * from a normal wfGetDB() connection. * - * - Unbuffered queries cause the MySQL server to use large amounts of + * - Unbuffered queries cause the MySQL server to use large amounts of * memory and to hold broad locks which block other queries. * - * If you want to limit client-side memory, it's almost always better to + * If you want to limit client-side memory, it's almost always better to * split up queries into batches using a LIMIT clause than to switch off * buffering. * + * @param $buffer null|bool + * * @return The previous value of the flag */ function bufferResults( $buffer = null ) { @@ -297,7 +299,7 @@ abstract class DatabaseBase implements DatabaseType { /** * Gets or sets the current transaction level. * - * Historically, transactions were allowed to be "nested". This is no + * Historically, transactions were allowed to be "nested". This is no * longer supported, so this function really only returns a boolean. * * @param $level An integer (0 or 1), or omitted to leave it unchanged. @@ -326,10 +328,10 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Get properties passed down from the server info array of the load + * Get properties passed down from the server info array of the load * balancer. * - * @param $name The entry of the info array to get, or null to get the + * @param $name The entry of the info array to get, or null to get the * whole array */ function getLBInfo( $name = null ) { @@ -345,8 +347,8 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Set the LB info array, or a member of it. If called with one parameter, - * the LB info array is set to that parameter. If it is called with two + * Set the LB info array, or a member of it. If called with one parameter, + * the LB info array is set to that parameter. If it is called with two * parameters, the member with the given name is set to the given value. * * @param $name @@ -695,14 +697,14 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Run an SQL query and return the result. Normally throws a DBQueryError + * Run an SQL query and return the result. Normally throws a DBQueryError * on failure. If errors are ignored, returns false instead. * - * In new code, the query wrappers select(), insert(), update(), delete(), - * etc. should be used where possible, since they give much better DBMS + * In new code, the query wrappers select(), insert(), update(), delete(), + * etc. should be used where possible, since they give much better DBMS * independence and automatically quote or validate user input in a variety * of contexts. This function is generally only useful for queries which are - * explicitly DBMS-dependent and are unsupported by the query wrappers, such + * explicitly DBMS-dependent and are unsupported by the query wrappers, such * as CREATE TABLE. * * However, the query wrappers themselves should call this function. @@ -712,7 +714,7 @@ abstract class DatabaseBase implements DatabaseType { * comment (you can use __METHOD__ or add some extra info) * @param $tempIgnore Boolean: Whether to avoid throwing an exception on errors... * maybe best to catch the exception instead? - * @return boolean|ResultWrapper. true for a successful write query, ResultWrapper object + * @return boolean|ResultWrapper. true for a successful write query, ResultWrapper object * for a successful read query, or false on failure if $tempIgnore set * @throws DBQueryError Thrown when the database returns an error of any kind */ @@ -821,7 +823,7 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Report a query error. Log the error, and if neither the object ignore + * Report a query error. Log the error, and if neither the object ignore * flag nor the $tempIgnore flag is set, throw a DBQueryError. * * @param $error String @@ -855,7 +857,7 @@ abstract class DatabaseBase implements DatabaseType { * & = filename; reads the file and inserts as a blob * (we don't use this though...) * - * This function should not be used directly by new code outside of the + * This function should not be used directly by new code outside of the * database classes. The query wrapper functions (select() etc.) should be * used instead. * @@ -898,7 +900,7 @@ abstract class DatabaseBase implements DatabaseType { * Prepare & execute an SQL statement, quoting and inserting arguments * in the appropriate places. * - * This function should not be used directly by new code outside of the + * This function should not be used directly by new code outside of the * database classes. The query wrapper functions (select() etc.) should be * used instead. * @@ -967,8 +969,8 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Free a result object returned by query() or select(). It's usually not - * necessary to call this, just use unset() or let the variable holding + * Free a result object returned by query() or select(). It's usually not + * necessary to call this, just use unset() or let the variable holding * the result object go out of scope. * * @param $res Mixed: A SQL result @@ -997,22 +999,22 @@ abstract class DatabaseBase implements DatabaseType { /** * A SELECT wrapper which returns a single field from a single result row. * - * Usually throws a DBQueryError on failure. If errors are explicitly + * Usually throws a DBQueryError on failure. If errors are explicitly * ignored, returns false on failure. * * If no result rows are returned from the query, false is returned. * - * @param $table Table name. See DatabaseBase::select() for details. - * @param $var The field name to select. This must be a valid SQL + * @param $table string|array Table name. See DatabaseBase::select() for details. + * @param $var string The field name to select. This must be a valid SQL * fragment: do not use unvalidated user input. - * @param $cond The condition array. See DatabaseBase::select() for details. - * @param $fname The function name of the caller. - * @param $options The query options. See DatabaseBase::select() for details. + * @param $cond string|array The condition array. See DatabaseBase::select() for details. + * @param $fname string The function name of the caller. + * @param $options string|array The query options. See DatabaseBase::select() for details. * * @return The value from the field, or false on failure. */ - function selectField( $table, $var, $cond = '', $fname = 'DatabaseBase::selectField', - $options = array() ) + function selectField( $table, $var, $cond = '', $fname = 'DatabaseBase::selectField', + $options = array() ) { if ( !is_array( $options ) ) { $options = array( $options ); @@ -1037,7 +1039,7 @@ abstract class DatabaseBase implements DatabaseType { /** * Returns an optional USE INDEX clause to go after the table, and a - * string to go at the end of the query. + * string to go at the end of the query. * * @param $options Array: associative array of options to be turned into * an SQL query, valid keys are listed in the function. @@ -1146,102 +1148,102 @@ abstract class DatabaseBase implements DatabaseType { * @param $join_conds Array Join conditions * * - * @b $table + * @param $table string|array * - * May be either an array of table names, or a single string holding a table - * name. If an array is given, table aliases can be specified, for example: + * May be either an array of table names, or a single string holding a table + * name. If an array is given, table aliases can be specified, for example: * * array( 'a' => 'user' ) * - * This includes the user table in the query, with the alias "a" available + * This includes the user table in the query, with the alias "a" available * for use in field names (e.g. a.user_name). * - * All of the table names given here are automatically run through - * DatabaseBase::tableName(), which causes the table prefix (if any) to be + * All of the table names given here are automatically run through + * DatabaseBase::tableName(), which causes the table prefix (if any) to be * added, and various other table name mappings to be performed. * * - * @b $vars + * @param $vars string|array * - * May be either a field name or an array of field names. The field names - * here are complete fragments of SQL, for direct inclusion into the SELECT + * May be either a field name or an array of field names. The field names + * here are complete fragments of SQL, for direct inclusion into the SELECT * query. Expressions and aliases may be specified as in SQL, for example: * * array( 'MAX(rev_id) AS maxrev' ) - * - * If an expression is given, care must be taken to ensure that it is + * + * If an expression is given, care must be taken to ensure that it is * DBMS-independent. * * - * @b $conds + * @param $conds string|array * - * May be either a string containing a single condition, or an array of - * conditions. If an array is given, the conditions constructed from each - * element are combined with AND. + * May be either a string containing a single condition, or an array of + * conditions. If an array is given, the conditions constructed from each + * element are combined with AND. * * Array elements may take one of two forms: * * - Elements with a numeric key are interpreted as raw SQL fragments. - * - Elements with a string key are interpreted as equality conditions, + * - Elements with a string key are interpreted as equality conditions, * where the key is the field name. - * - If the value of such an array element is a scalar (such as a - * string), it will be treated as data and thus quoted appropriately. + * - If the value of such an array element is a scalar (such as a + * string), it will be treated as data and thus quoted appropriately. * If it is null, an IS NULL clause will be added. - * - If the value is an array, an IN(...) clause will be constructed, - * such that the field name may match any of the elements in the + * - If the value is an array, an IN(...) clause will be constructed, + * such that the field name may match any of the elements in the * array. The elements of the array will be quoted. - * - If the field name ends with "!", this is taken as a flag which - * inverts the comparison, allowing NOT IN clauses to be constructed, + * - If the field name ends with "!", this is taken as a flag which + * inverts the comparison, allowing NOT IN clauses to be constructed, * for example: array( 'user_id!' => array( 1, 2, 3 ) ) * - * Note that expressions are often DBMS-dependent in their syntax. - * DBMS-independent wrappers are provided for constructing several types of + * Note that expressions are often DBMS-dependent in their syntax. + * DBMS-independent wrappers are provided for constructing several types of * expression commonly used in condition queries. See: * - DatabaseBase::buildLike() * - DatabaseBase::conditional() * * - * @b $options + * @param $options string|array * - * Optional: Array of query options. Boolean options are specified by - * including them in the array as a string value with a numeric key, for + * Optional: Array of query options. Boolean options are specified by + * including them in the array as a string value with a numeric key, for * example: * * array( 'FOR UPDATE' ) * * The supported options are: * - * - OFFSET: Skip this many rows at the start of the result set. OFFSET + * - OFFSET: Skip this many rows at the start of the result set. OFFSET * with LIMIT can theoretically be used for paging through a result set, - * but this is discouraged in MediaWiki for performance reasons. + * but this is discouraged in MediaWiki for performance reasons. * - * - LIMIT: Integer: return at most this many rows. The rows are sorted + * - LIMIT: Integer: return at most this many rows. The rows are sorted * and then the first rows are taken until the limit is reached. LIMIT * is applied to a result set after OFFSET. * - * - FOR UPDATE: Boolean: lock the returned rows so that they can't be + * - FOR UPDATE: Boolean: lock the returned rows so that they can't be * changed until the next COMMIT. * * - DISTINCT: Boolean: return only unique result rows. * - * - GROUP BY: May be either an SQL fragment string naming a field or + * - GROUP BY: May be either an SQL fragment string naming a field or * expression to group by, or an array of such SQL fragments. * - * - HAVING: A string containing a HAVING clause. + * - HAVING: A string containing a HAVING clause. * - * - ORDER BY: May be either an SQL fragment giving a field name or + * - ORDER BY: May be either an SQL fragment giving a field name or * expression to order by, or an array of such SQL fragments. * - * - USE INDEX: This may be either a string giving the index name to use - * for the query, or an array. If it is an associative array, each key + * - USE INDEX: This may be either a string giving the index name to use + * for the query, or an array. If it is an associative array, each key * gives the table name (or alias), each value gives the index name to - * use for that table. All strings are SQL fragments and so should be + * use for that table. All strings are SQL fragments and so should be * validated by the caller. * - * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run, + * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run, * instead of SELECT. * - * And also the following boolean MySQL extensions, see the MySQL manual + * And also the following boolean MySQL extensions, see the MySQL manual * for documentation: * * - LOCK IN SHARE MODE @@ -1255,27 +1257,26 @@ abstract class DatabaseBase implements DatabaseType { * - SQL_NO_CACHE * * - * @b $join_conds + * @param $join_conds string|array * - * Optional associative array of table-specific join conditions. In the - * most common case, this is unnecessary, since the join condition can be + * Optional associative array of table-specific join conditions. In the + * most common case, this is unnecessary, since the join condition can be * in $conds. However, it is useful for doing a LEFT JOIN. * - * The key of the array contains the table name or alias. The value is an - * array with two elements, numbered 0 and 1. The first gives the type of - * join, the second is an SQL fragment giving the join condition for that + * The key of the array contains the table name or alias. The value is an + * array with two elements, numbered 0 and 1. The first gives the type of + * join, the second is an SQL fragment giving the join condition for that * table. For example: * * array( 'page' => array('LEFT JOIN','page_latest=rev_id') ) * * @return ResultWrapper. If the query returned no rows, a ResultWrapper - * with no rows in it will be returned. If there was a query error, a + * with no rows in it will be returned. If there was a query error, a * DBQueryError exception will be thrown, except if the "ignore errors" * option was set, in which case false will be returned. */ - function select( $table, $vars, $conds = '', $fname = 'DatabaseBase::select', - $options = array(), $join_conds = array() ) - { + function select( $table, $vars, $conds = '', $fname = 'DatabaseBase::select', + $options = array(), $join_conds = array() ) { $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds ); return $this->query( $sql, $fname ); @@ -1285,12 +1286,12 @@ abstract class DatabaseBase implements DatabaseType { * The equivalent of DatabaseBase::select() except that the constructed SQL * is returned, instead of being immediately executed. * - * @param $table Table name - * @param $vars Field names - * @param $conds Conditions - * @param $fname Caller function name - * @param $options Query options - * @param $join_conds Join conditions + * @param $table string|array Table name + * @param $vars string|array Field names + * @param $conds string|array Conditions + * @param $fname string Caller function name + * @param $options string|array Query options + * @param $join_conds string|array Join conditions * * @return SQL query string. * @see DatabaseBase::select() @@ -1348,20 +1349,20 @@ abstract class DatabaseBase implements DatabaseType { /** * Single row SELECT wrapper. Equivalent to DatabaseBase::select(), except - * that a single row object is returned. If the query returns no rows, + * that a single row object is returned. If the query returns no rows, * false is returned. * - * @param $table Table name - * @param $vars Field names - * @param $conds Conditions - * @param $fname Caller function name - * @param $options Query options - * @param $join_conds Join conditions + * @param $table string|array Table name + * @param $vars string|array Field names + * @param $conds|array Conditions + * @param $fname string Caller function name + * @param $options string|array Query options + * @param $join_conds array|string Join conditions * - * @return ResultWrapper or bool + * @return ResultWrapper|bool */ - function selectRow( $table, $vars, $conds, $fname = 'DatabaseBase::selectRow', - $options = array(), $join_conds = array() ) + function selectRow( $table, $vars, $conds, $fname = 'DatabaseBase::selectRow', + $options = array(), $join_conds = array() ) { $options['LIMIT'] = 1; $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds ); @@ -1382,13 +1383,13 @@ abstract class DatabaseBase implements DatabaseType { /** * Estimate rows in dataset. * - * MySQL allows you to estimate the number of rows that would be returned + * MySQL allows you to estimate the number of rows that would be returned * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using * index cardinality statistics, and is notoriously inaccurate, especially * when large numbers of rows have recently been added or deleted. * * For DBMSs that don't support fast result size estimation, this function - * will actually perform the SELECT COUNT(*). + * will actually perform the SELECT COUNT(*). * * Takes the same arguments as DatabaseBase::select(). * @@ -1399,8 +1400,8 @@ abstract class DatabaseBase implements DatabaseType { * @param $options Array: options for select * @return Integer: row count */ - public function estimateRowCount( $table, $vars = '*', $conds = '', - $fname = 'DatabaseBase::estimateRowCount', $options = array() ) + public function estimateRowCount( $table, $vars = '*', $conds = '', + $fname = 'DatabaseBase::estimateRowCount', $options = array() ) { $rows = 0; $res = $this->select ( $table, 'COUNT(*) AS rowcount', $conds, $fname, $options ); @@ -1530,23 +1531,23 @@ abstract class DatabaseBase implements DatabaseType { * $a may be either: * * - A single associative array. The array keys are the field names, and - * the values are the values to insert. The values are treated as data - * and will be quoted appropriately. If NULL is inserted, this will be + * the values are the values to insert. The values are treated as data + * and will be quoted appropriately. If NULL is inserted, this will be * converted to a database NULL. - * - An array with numeric keys, holding a list of associative arrays. + * - An array with numeric keys, holding a list of associative arrays. * This causes a multi-row INSERT on DBMSs that support it. The keys in * each subarray must be identical to each other, and in the same order. * - * Usually throws a DBQueryError on failure. If errors are explicitly ignored, + * Usually throws a DBQueryError on failure. If errors are explicitly ignored, * returns success. * - * $options is an array of options, with boolean options encoded as values - * with numeric keys, in the same style as $options in + * $options is an array of options, with boolean options encoded as values + * with numeric keys, in the same style as $options in * DatabaseBase::select(). Supported options are: * - * - IGNORE: Boolean: if present, duplicate key errors are ignored, and - * any rows which cause duplicate key errors are not inserted. It's - * possible to determine how many rows were successfully inserted using + * - IGNORE: Boolean: if present, duplicate key errors are ignored, and + * any rows which cause duplicate key errors are not inserted. It's + * possible to determine how many rows were successfully inserted using * DatabaseBase::affectedRows(). * * @param $table String Table name. This will be passed through @@ -1629,13 +1630,13 @@ abstract class DatabaseBase implements DatabaseType { * @param $table String name of the table to UPDATE. This will be passed through * DatabaseBase::tableName(). * - * @param $values Array: An array of values to SET. For each array element, + * @param $values Array: An array of values to SET. For each array element, * the key gives the field name, and the value gives the data - * to set that field to. The data will be quoted by + * to set that field to. The data will be quoted by * DatabaseBase::addQuotes(). * - * @param $conds Array: An array of conditions (WHERE). See - * DatabaseBase::select() for the details of the format of + * @param $conds Array: An array of conditions (WHERE). See + * DatabaseBase::select() for the details of the format of * condition arrays. Use '*' to update all rows. * * @param $fname String: The function name of the caller (from __METHOD__), @@ -1663,7 +1664,7 @@ abstract class DatabaseBase implements DatabaseType { * @param $a Array containing the data * @param $mode: * - LIST_COMMA: comma separated, no field names - * - LIST_AND: ANDed WHERE clause (without the WHERE). See + * - LIST_AND: ANDed WHERE clause (without the WHERE). See * the documentation for $conds in DatabaseBase::select(). * - LIST_OR: ORed WHERE clause (without the WHERE) * - LIST_SET: comma separated with field names, like a SET clause @@ -2219,19 +2220,19 @@ abstract class DatabaseBase implements DatabaseType { * * REPLACE is a very handy MySQL extension, which functions like an INSERT * except that when there is a duplicate key error, the old row is deleted - * and the new row is inserted in its place. + * and the new row is inserted in its place. * - * We simulate this with standard SQL with a DELETE followed by INSERT. To - * perform the delete, we need to know what the unique indexes are so that + * We simulate this with standard SQL with a DELETE followed by INSERT. To + * perform the delete, we need to know what the unique indexes are so that * we know how to find the conflicting rows. * - * It may be more efficient to leave off unique indexes which are unlikely - * to collide. However if you do this, you run the risk of encountering + * It may be more efficient to leave off unique indexes which are unlikely + * to collide. However if you do this, you run the risk of encountering * errors which wouldn't have occurred in MySQL. - * - * @param $rows Can be either a single row to insert, or multiple rows, + * + * @param $rows Can be either a single row to insert, or multiple rows, * in the same format as for DatabaseBase::insert() - * @param $uniqueIndexes is an array of indexes. Each element may be either + * @param $uniqueIndexes is an array of indexes. Each element may be either * a field name or an array of field names * * @param $table String: The table to replace the row(s) in. @@ -2321,10 +2322,10 @@ abstract class DatabaseBase implements DatabaseType { /** * DELETE where the condition is a join. * - * MySQL overrides this to use a multi-table DELETE syntax, in other databases + * MySQL overrides this to use a multi-table DELETE syntax, in other databases * we use sub-selects * - * For safety, an empty $conds will not delete everything. If you want to + * For safety, an empty $conds will not delete everything. If you want to * delete all rows where the join condition matches, set $conds='*'. * * DO NOT put the join condition in $conds. @@ -2333,16 +2334,16 @@ abstract class DatabaseBase implements DatabaseType { * @param $joinTable String: The other table. * @param $delVar String: The variable to join on, in the first table. * @param $joinVar String: The variable to join on, in the second table. - * @param $conds Array: Condition array of field names mapped to variables, + * @param $conds Array: Condition array of field names mapped to variables, * ANDed together in the WHERE clause - * @param $fname String: Calling function name (use __METHOD__) for + * @param $fname String: Calling function name (use __METHOD__) for * logs/profiling */ - function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, - $fname = 'DatabaseBase::deleteJoin' ) + function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, + $fname = 'DatabaseBase::deleteJoin' ) { if ( !$conds ) { - throw new DBUnexpectedError( $this, + throw new DBUnexpectedError( $this, 'DatabaseBase::deleteJoin() called with empty $conds' ); } @@ -2382,7 +2383,7 @@ abstract class DatabaseBase implements DatabaseType { * MySQL's LOW_PRIORITY. If no such feature exists, return an empty * string and nothing bad should happen. * - * @return string Returns the text of the low priority option if it is + * @return string Returns the text of the low priority option if it is * supported, or a blank string otherwise */ function lowPriorityOption() { @@ -2422,25 +2423,25 @@ abstract class DatabaseBase implements DatabaseType { * @param $srcTable May be either a table name, or an array of table names * to include in a join. * - * @param $varMap must be an associative array of the form - * array( 'dest1' => 'source1', ...). Source items may be literals - * rather than field names, but strings should be quoted with + * @param $varMap must be an associative array of the form + * array( 'dest1' => 'source1', ...). Source items may be literals + * rather than field names, but strings should be quoted with * DatabaseBase::addQuotes() * - * @param $conds Condition array. See $conds in DatabaseBase::select() for - * the details of the format of condition arrays. May be "*" to copy the + * @param $conds Condition array. See $conds in DatabaseBase::select() for + * the details of the format of condition arrays. May be "*" to copy the * whole table. * * @param $fname The function name of the caller, from __METHOD__ * - * @param $insertOptions Options for the INSERT part of the query, see + * @param $insertOptions Options for the INSERT part of the query, see * DatabaseBase::insert() for details. * @param $selectOptions Options for the SELECT part of the query, see * DatabaseBase::select() for details. * * @return ResultWrapper */ - function insertSelect( $destTable, $srcTable, $varMap, $conds, + function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabaseBase::insertSelect', $insertOptions = array(), $selectOptions = array() ) { @@ -2652,11 +2653,11 @@ abstract class DatabaseBase implements DatabaseType { * Wait for the slave to catch up to a given master position. * * @param $pos DBMasterPos object - * @param $timeout Integer: the maximum number of seconds to wait for + * @param $timeout Integer: the maximum number of seconds to wait for * synchronisation * * @return An integer: zero if the slave was past that position already, - * greater than zero if we waited for some period of time, less than + * greater than zero if we waited for some period of time, less than * zero if we timed out. */ function masterPosWait( DBMasterPos $pos, $timeout ) { @@ -2760,10 +2761,10 @@ abstract class DatabaseBase implements DatabaseType { * @param $fname String: calling function name * @return Boolean: true if operation was successful */ - function duplicateTableStructure( $oldName, $newName, $temporary = false, - $fname = 'DatabaseBase::duplicateTableStructure' ) + function duplicateTableStructure( $oldName, $newName, $temporary = false, + $fname = 'DatabaseBase::duplicateTableStructure' ) { - throw new MWException( + throw new MWException( 'DatabaseBase::duplicateTableStructure is not implemented in descendant class' ); } @@ -2778,10 +2779,10 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Convert a timestamp in one of the formats accepted by wfTimestamp() + * Convert a timestamp in one of the formats accepted by wfTimestamp() * to the format used for inserting into timestamp fields in this DBMS. * - * The result is unquoted, and needs to be passed through addQuotes() + * The result is unquoted, and needs to be passed through addQuotes() * before it can be included in raw SQL. * * @return string @@ -2791,12 +2792,12 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Convert a timestamp in one of the formats accepted by wfTimestamp() - * to the format used for inserting into timestamp fields in this DBMS. If - * NULL is input, it is passed through, allowing NULL values to be inserted + * Convert a timestamp in one of the formats accepted by wfTimestamp() + * to the format used for inserting into timestamp fields in this DBMS. If + * NULL is input, it is passed through, allowing NULL values to be inserted * into timestamp fields. * - * The result is unquoted, and needs to be passed through addQuotes() + * The result is unquoted, and needs to be passed through addQuotes() * before it can be included in raw SQL. * * @return string @@ -2810,14 +2811,14 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Take the result from a query, and wrap it in a ResultWrapper if - * necessary. Boolean values are passed through as is, to indicate success - * of write queries or failure. + * Take the result from a query, and wrap it in a ResultWrapper if + * necessary. Boolean values are passed through as is, to indicate success + * of write queries or failure. * - * Once upon a time, DatabaseBase::query() returned a bare MySQL result + * Once upon a time, DatabaseBase::query() returned a bare MySQL result * resource, and it was necessary to call this function to convert it to * a wrapper. Nowadays, raw database objects are never exposed to external - * callers, so this is unnecessary in external code. For compatibility with + * callers, so this is unnecessary in external code. For compatibility with * old code, ResultWrapper objects are passed through unaltered. */ function resultObject( $result ) { @@ -2869,10 +2870,10 @@ abstract class DatabaseBase implements DatabaseType { } /** - * Some DBMSs have a special format for inserting into blob fields, they - * don't allow simple quoted strings to be inserted. To insert into such - * a field, pass the data through this function before passing it to - * DatabaseBase::insert(). + * Some DBMSs have a special format for inserting into blob fields, they + * don't allow simple quoted strings to be inserted. To insert into such + * a field, pass the data through this function before passing it to + * DatabaseBase::insert(). */ function encodeBlob( $b ) { return $b; @@ -2880,7 +2881,7 @@ abstract class DatabaseBase implements DatabaseType { /** * Some DBMSs return a special placeholder object representing blob fields - * in result objects. Pass the object through this function to return the + * in result objects. Pass the object through this function to return the * original string. */ function decodeBlob( $b ) { @@ -2900,13 +2901,13 @@ abstract class DatabaseBase implements DatabaseType { /** * Read and execute SQL commands from a file. * - * Returns true on success, error string or exception on failure (depending + * Returns true on success, error string or exception on failure (depending * on object's error ignore settings). * * @param $filename String: File name to open * @param $lineCallback Callback: Optional function called before reading each line * @param $resultCallback Callback: Optional function called for each MySQL result - * @param $fname String: Calling function name or false if name should be + * @param $fname String: Calling function name or false if name should be * generated dynamically using $filename */ function sourceFile( $filename, $lineCallback = false, $resultCallback = false, $fname = false ) { @@ -2968,7 +2969,7 @@ abstract class DatabaseBase implements DatabaseType { /** * Read and execute commands from an open file handle. * - * Returns true on success, error string or exception on failure (depending + * Returns true on success, error string or exception on failure (depending * on object's error ignore settings). * * @param $fp Resource: File handle @@ -2976,8 +2977,8 @@ abstract class DatabaseBase implements DatabaseType { * @param $resultCallback Callback: Optional function called for each MySQL result * @param $fname String: Calling function name */ - function sourceStream( $fp, $lineCallback = false, $resultCallback = false, - $fname = 'DatabaseBase::sourceStream' ) + function sourceStream( $fp, $lineCallback = false, $resultCallback = false, + $fname = 'DatabaseBase::sourceStream' ) { $cmd = ""; $done = false; @@ -3050,12 +3051,12 @@ abstract class DatabaseBase implements DatabaseType { * * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables. * - * - '{$var}' should be used for text and is passed through the database's + * - '{$var}' should be used for text and is passed through the database's * addQuotes method. - * - `{$var}` should be used for identifiers (eg: table and database names), - * it is passed through the database's addIdentifierQuotes method which + * - `{$var}` should be used for identifiers (eg: table and database names), + * it is passed through the database's addIdentifierQuotes method which * can be overridden if the database uses something other than backticks. - * - / *$var* / is just encoded, besides traditional table prefix and + * - / *$var* / is just encoded, besides traditional table prefix and * table options its use should be avoided. * * @param $ins String: SQL statement to replace variables in @@ -3076,6 +3077,10 @@ abstract class DatabaseBase implements DatabaseType { /** * Replace variables in sourced SQL + * + * @param $ins string + * + * @return string */ protected function replaceVars( $ins ) { $ins = $this->replaceSchemaVars( $ins ); @@ -3108,6 +3113,8 @@ abstract class DatabaseBase implements DatabaseType { * * Override this in derived classes to provide variables for tables.sql * and SQL patch files. + * + * @return array */ protected function getDefaultSchemaVars() { return array(); @@ -3115,7 +3122,10 @@ abstract class DatabaseBase implements DatabaseType { /** * Table name callback - * @private + * + * @param $matches array + * + * @return string */ protected function tableNameCallback( $matches ) { return $this->tableName( $matches[1] ); @@ -3123,6 +3133,10 @@ abstract class DatabaseBase implements DatabaseType { /** * Index name callback + * + * @param $matches array + * + * @return string */ protected function indexNameCallback( $matches ) { return $this->indexName( $matches[1] ); @@ -3173,6 +3187,8 @@ abstract class DatabaseBase implements DatabaseType { * @param $write Array of tables to lock for write access * @param $method String name of caller * @param $lowPriority bool Whether to indicate writes to be LOW PRIORITY + * + * @return bool */ public function lockTables( $read, $write, $method, $lowPriority = true ) { return true; @@ -3182,6 +3198,8 @@ abstract class DatabaseBase implements DatabaseType { * Unlock specific tables * * @param $method String the caller + * + * @return bool */ public function unlockTables( $method ) { return true; @@ -3189,6 +3207,9 @@ abstract class DatabaseBase implements DatabaseType { /** * Delete a table + * @param $tableName string + * @param $fName string + * @return bool|ResultWrapper */ public function dropTable( $tableName, $fName = 'DatabaseBase::dropTable' ) { if( !$this->tableExists( $tableName ) ) { @@ -3242,7 +3263,7 @@ abstract class DatabaseBase implements DatabaseType { * * This is a MySQL-specific feature. * - * @param $value Mixed: true for allow, false for deny, or "default" to + * @param $value Mixed: true for allow, false for deny, or "default" to * restore the initial value */ public function setBigSelects( $value = true ) { -- 2.20.1