Index: includes/database/database.inc =================================================================== RCS file: /cvs/drupal/drupal/includes/database/database.inc,v retrieving revision 1.95 diff -u -r1.95 database.inc --- includes/database/database.inc 8 Feb 2010 19:35:39 -0000 1.95 +++ includes/database/database.inc 11 Feb 2010 18:41:37 -0000 @@ -31,15 +31,15 @@ * For example, one might wish to return a list of the most recent 10 nodes * authored by a given user. Instead of directly issuing the SQL query * @code - * SELECT n.nid, n.title, n.created FROM node n WHERE n.uid = $uid LIMIT 0, 10; + * SELECT n.nid, n.title, n.created FROM node n WHERE n.uid = $uid LIMIT 0, 10 * @endcode * one would instead call the Drupal functions: * @code - * $result = db_query_range('SELECT n.nid, n.title, n.created - * FROM {node} n WHERE n.uid = :uid', array(':uid' => $uid), 0, 10); - * foreach($result as $record) { - * // Perform operations on $node->title, etc. here. - * } + * $result = db_query_range('SELECT n.nid, n.title, n.created + * FROM {node} n WHERE n.uid = :uid', array(':uid' => $uid), 0, 10) + * foreach($result as $record) { + * // Perform operations on $node->title, etc. here. + * } * @endcode * Curly braces are used around "node" to provide table prefixing via * DatabaseConnection::prefixTables(). The explicit use of a user ID is pulled @@ -105,7 +105,8 @@ * * INSERT, UPDATE, and DELETE queries need special care in order to behave * consistently across all different databases. Therefore, they use a special - * object-oriented API for defining a query structurally. For example, rather than + * object-oriented API for defining a query structurally. + * For example, rather than * @code * INSERT INTO node (nid, title, body) VALUES (1, 'my title', 'my body') * @endcode @@ -169,7 +170,6 @@ * } * } * @endcode - * */ @@ -1185,7 +1185,6 @@ * This class is uninstantiatable and un-extendable. It acts to encapsulate * all control and shepherding of database connections into a single location * without the use of globals. - * */ abstract class Database { @@ -1340,7 +1339,7 @@ * The logging key to log. * @param $key * The database connection key for which we want to log. - * @return array + * @return Array * The query log for the specified logging key and connection. */ final public static function getLog($logging_key, $key = 'default') { @@ -1593,7 +1592,8 @@ } /** - * Exception to throw when popTransaction() is called when no transaction is active. + * Exception to throw when popTransaction() is called when no transaction is + * active. */ class NoActiveTransactionException extends Exception { } @@ -1641,8 +1641,9 @@ * commands, allowing user-space code to proceed normally. The only difference * is that rollbacks won't actually do anything. * - * In the vast majority of cases, you should not instantiate this class directly. - * Instead, call ->startTransaction(), from the appropriate connection object. + * In the vast majority of cases, you should not instantiate this class + * directly. Instead, call ->startTransaction(), from the appropriate connection + * object. */ class DatabaseTransaction { @@ -1717,14 +1718,16 @@ * * Child implementations should either extend PDOStatement: * @code - * class DatabaseStatement_oracle extends PDOStatement implements DatabaseStatementInterface {} + * class DatabaseStatement_oracle extends PDOStatement implements + * DatabaseStatementInterface {} * @endcode * * …or implement their own class, but in that case they will also have to * implement the Iterator or IteratorArray interfaces before * DatabaseStatementInterface: * @code - * class DatabaseStatement_oracle implements Iterator, DatabaseStatementInterface {} + * class DatabaseStatement_oracle implements Iterator, + * DatabaseStatementInterface {} * @endcode */ interface DatabaseStatementInterface extends Traversable { @@ -2078,6 +2081,7 @@ /** * The following utility functions are simply convenience wrappers. + * * They should never, ever have any database-specific code in them. */ @@ -2112,8 +2116,7 @@ } /** - * Execute an arbitrary query string against the active database, restricted to - * a specified range. + * Execute an arbitrary query string against the active database, restricted to a specified range. * * @see DatabaseConnection::defaultOptions() * @param $query @@ -2143,8 +2146,7 @@ } /** - * Execute a query string against the active database and save the result set - * to a temp table. + * Execute a query string against the active database and save the result set to a temp table. * * @see DatabaseConnection::defaultOptions() * @param $query @@ -2363,10 +2365,10 @@ } /** - * Retrieve the name of the currently active database driver, such as "mysql" or - * "pgsql". + * Retrieve the name of the currently active database driver, such as "mysql" or "pgsql". * - * @return The name of the currently active database driver. + * @return + * The name of the currently active database driver. */ function db_driver() { return Database::getConnection()->driver(); @@ -2487,8 +2489,7 @@ } /** - * This maps a generic data type in combination with its data size - * to the engine-specific data type. + * This maps a generic data type in combination with its data size to the engine-specific data type. */ function db_type_map() { return Database::getConnection()->schema()->getFieldTypeMap(); @@ -2721,16 +2722,17 @@ */ /** - * Prints a themed maintenance page with the 'Site offline' text, adding the - * provided error message in the case of 'display_errors' set to on. Ends the - * page request; no return. + * Prints a themed maintenance page with the 'Site offline' text. + * + * Adding the provided error message in the case of 'display_errors' set to on. + * Ends the page request; no return. */ function _db_error_page($error = '') { global $db_type; drupal_language_initialize(); drupal_maintenance_theme(); drupal_add_http_header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable'); - drupal_set_title('Site offline'); + drupal_set_title(t('Site offline')); } /**