Merge "rdbms: clarify IDatabase::setTransactionListener() comment"
[lhc/web/wiklou.git] / includes / libs / rdbms / database / IDatabase.php
index 7da259d..f38ddb8 100644 (file)
@@ -370,18 +370,6 @@ interface IDatabase {
         */
        public function getType();
 
-       /**
-        * Open a new connection to the database (closing any existing one)
-        *
-        * @param string $server Database server host
-        * @param string $user Database user name
-        * @param string $password Database user password
-        * @param string $dbName Database name
-        * @return bool
-        * @throws DBConnectionError
-        */
-       public function open( $server, $user, $password, $dbName );
-
        /**
         * Fetch the next row from the given result object, in object form.
         * Fields can be retrieved with $row->fieldname, with fields acting like
@@ -498,8 +486,8 @@ interface IDatabase {
         * Close the database connection
         *
         * This should only be called after any transactions have been resolved,
-        * aside from read-only transactions (assuming no callbacks are registered).
-        * If a transaction is still open anyway, it will be committed if possible.
+        * aside from read-only automatic transactions (assuming no callbacks are registered).
+        * If a transaction is still open anyway, it will be rolled back.
         *
         * @throws DBError
         * @return bool Operation success. true if already closed.
@@ -682,6 +670,8 @@ interface IDatabase {
         * Escaping of untrusted input used in values of numeric keys should be done via
         * IDatabase::addQuotes()
         *
+        * Use an empty array, string, or '*' to update all rows.
+        *
         * @param string|array $options
         *
         * Optional: Array of query options. Boolean options are specified by
@@ -1585,7 +1575,7 @@ interface IDatabase {
        public function onTransactionPreCommitOrIdle( callable $callback, $fname = __METHOD__ );
 
        /**
-        * Run a callback each time any transaction commits or rolls back
+        * Run a callback after each time any transaction commits or rolls back
         *
         * The callback takes two arguments:
         *   - IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK