WordPress 3.3.2-scripts
[autoinstalls/wordpress.git] / wp-includes / wp-db.php
index 0cae3e638e2d626d0d6a55c17e3b77439d215da8..e9ada84dcc02b43f8bc7c027c0e07a7ea22bd612 100644 (file)
@@ -71,9 +71,7 @@ class wpdb {
        /**
         * The last error during query.
         *
-        * @see get_last_error()
         * @since 2.5.0
-        * @access private
         * @var string
         */
        var $last_error = '';
@@ -460,6 +458,20 @@ class wpdb {
         */
        var $func_call;
 
+       /**
+        * Whether MySQL is used as the database engine.
+        *
+        * Set in WPDB::db_connect() to true, by default. This is used when checking
+        * against the required MySQL version for WordPress. Normally, a replacement
+        * database drop-in (db.php) will skip these checks, but setting this to true
+        * will force the checks to occur.
+        *
+        * @since 3.3.0
+        * @access public
+        * @var bool
+        */
+       public $is_mysql = null;
+
        /**
         * Connects to the database server and selects a database
         *
@@ -555,6 +567,7 @@ class wpdb {
         * @since 2.5.0
         *
         * @param string $prefix Alphanumeric name for the new prefix.
+        * @param bool $set_table_names Optional. Whether the table names, e.g. wpdb::$posts, should be updated or not.
         * @return string|WP_Error Old prefix or WP_Error on error
         */
        function set_prefix( $prefix, $set_table_names = true ) {
@@ -640,7 +653,7 @@ class wpdb {
         * Returns an array of WordPress tables.
         *
         * Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to
-        * override the WordPress users and usersmeta tables that would otherwise
+        * override the WordPress users and usermeta tables that would otherwise
         * be determined by the prefix.
         *
         * The scope argument can take one of the following:
@@ -726,7 +739,7 @@ class wpdb {
         * @param resource $dbh Optional link identifier.
         * @return null Always null.
         */
-       function select( $db, $dbh = null) {
+       function select( $db, $dbh = null ) {
                if ( is_null($dbh) )
                        $dbh = $this->dbh;
 
@@ -739,7 +752,7 @@ class wpdb {
 <li>Does the user <code>%2$s</code> have permission to use the <code>%1$s</code> database?</li>
 <li>On some systems the name of your database is prefixed with your username, so it would be like <code>username_%1$s</code>. Could that be the problem?</li>
 </ul>
-<p>If you don\'t know how to set up a database you should <strong>contact your host</strong>. If all else fails you may find help at the <a href="http://wordpress.org/support/">WordPress Support Forums</a>.</p>'/*/WP_I18N_DB_SELECT_DB*/, $db, $this->dbuser ), 'db_select_fail' );
+<p>If you don\'t know how to set up a database you should <strong>contact your host</strong>. If all else fails you may find help at the <a href="http://wordpress.org/support/">WordPress Support Forums</a>.</p>'/*/WP_I18N_DB_SELECT_DB*/, htmlspecialchars( $db, ENT_QUOTES ), htmlspecialchars( $this->dbuser, ENT_QUOTES ) ), 'db_select_fail' );
                        return;
                }
        }
@@ -842,14 +855,15 @@ class wpdb {
         * Prepares a SQL query for safe execution. Uses sprintf()-like syntax.
         *
         * The following directives can be used in the query format string:
-        *   %d (decimal number)
+        *   %d (integer)
+        *   %f (float)
         *   %s (string)
         *   %% (literal percentage sign - no argument needed)
         *
-        * Both %d and %s are to be left unquoted in the query string and they need an argument passed for them.
+        * All of %d, %f, and %s are to be left unquoted in the query string and they need an argument passed for them.
         * Literals (%) as parts of the query must be properly written as %%.
         *
-        * This function only supports a small subset of the sprintf syntax; it only supports %d (decimal number), %s (string).
+        * This function only supports a small subset of the sprintf syntax; it only supports %d (integer), %f (float), and %s (string).
         * Does not support sign, padding, alignment, width or precision specifiers.
         * Does not support argument numbering/swapping.
         *
@@ -1013,6 +1027,9 @@ class wpdb {
         * @since 3.0.0
         */
        function db_connect() {
+
+               $this->is_mysql = true;
+
                if ( WP_DEBUG ) {
                        $this->dbh = mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, true );
                } else {
@@ -1029,7 +1046,7 @@ class wpdb {
        <li>Are you sure that the database server is running?</li>
 </ul>
 <p>If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href='http://wordpress.org/support/'>WordPress Support Forums</a>.</p>
-"/*/WP_I18N_DB_CONN_ERROR*/, $this->dbhost ), 'db_connect_fail' );
+"/*/WP_I18N_DB_CONN_ERROR*/, htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' );
 
                        return;
                }
@@ -1132,7 +1149,7 @@ class wpdb {
         * @param string $table table name
         * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
         * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data.
-        *      A format is one of '%d', '%s' (decimal number, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+        *      A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
         * @return int|false The number of rows inserted, or false on error.
         */
        function insert( $table, $data, $format = null ) {
@@ -1155,7 +1172,7 @@ class wpdb {
         * @param string $table table name
         * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
         * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data.
-        *      A format is one of '%d', '%s' (decimal number, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+        *      A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
         * @return int|false The number of rows affected, or false on error.
         */
        function replace( $table, $data, $format = null ) {
@@ -1176,7 +1193,8 @@ class wpdb {
         * @param string $table table name
         * @param array $data Data to insert (in column => value pairs).  Both $data columns and $data values should be "raw" (neither should be SQL escaped).
         * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data.
-        *      A format is one of '%d', '%s' (decimal number, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+        *      A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+        * @param string $type Optional. What type of operation is this? INSERT or REPLACE. Defaults to INSERT.
         * @return int|false The number of rows affected, or false on error.
         */
        function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) {
@@ -1215,8 +1233,8 @@ class wpdb {
         * @param array $data Data to update (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
         * @param array $where A named array of WHERE clauses (in column => value pairs). Multiple clauses will be joined with ANDs. Both $where columns and $where values should be "raw".
         * @param array|string $format Optional. An array of formats to be mapped to each of the values in $data. If string, that format will be used for all of the values in $data.
-        *      A format is one of '%d', '%s' (decimal number, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
-        * @param array|string $format_where Optional. An array of formats to be mapped to each of the values in $where. If string, that format will be used for all of the items in $where.  A format is one of '%d', '%s' (decimal number, string).  If omitted, all values in $where will be treated as strings.
+        *      A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+        * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where. If string, that format will be used for all of the items in $where.  A format is one of '%d', '%f', '%s' (integer, float, string).  If omitted, all values in $where will be treated as strings.
         * @return int|false The number of rows updated, or false on error.
         */
        function update( $table, $data, $where, $format = null, $where_format = null ) {
@@ -1289,7 +1307,7 @@ class wpdb {
         * @param string $output Optional. one of ARRAY_A | ARRAY_N | OBJECT constants. Return an associative array (column => value, ...),
         *      a numerically indexed array (0 => value, ...) or an object ( ->column = value ), respectively.
         * @param int $y Optional. Row to return. Indexed from 0.
-        * @return mixed Database query result in format specifed by $output or null on failure
+        * @return mixed Database query result in format specified by $output or null on failure
         */
        function get_row( $query = null, $output = OBJECT, $y = 0 ) {
                $this->func_call = "\$db->get_row(\"$query\",$output,$y)";
@@ -1366,7 +1384,8 @@ class wpdb {
                        // Return an array of row objects with keys from column 1
                        // (Duplicates are discarded)
                        foreach ( $this->last_result as $row ) {
-                               $key = array_shift( get_object_vars( $row ) );
+                               $var_by_ref = get_object_vars( $row );
+                               $key = array_shift( $var_by_ref );
                                if ( ! isset( $new_array[ $key ] ) )
                                        $new_array[ $key ] = $row;
                        }