<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[43934] branches/5.0: WPDB: Check that `$wpdb->last_result` is countable before counting with it.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/43934">43934</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/43934","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-11-22 03:58:19 +0000 (Thu, 22 Nov 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>WPDB: Check that `$wpdb->last_result` is countable before counting with it.
`wpdb::get_col()` iterates over `$wpdb->last_result`, which can be a non-countable value, should the preceeding query have failed.
Props spacedmonkey, desrosj.
See <a href="https://core.trac.wordpress.org/ticket/45299">#45299</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches50srcwpincludeswpdbphp">branches/5.0/src/wp-includes/wp-db.php</a></li>
<li><a href="#branches50testsphpunittestsdbphp">branches/5.0/tests/phpunit/tests/db.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches50srcwpincludeswpdbphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-includes/wp-db.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-includes/wp-db.php 2018-11-22 03:20:30 UTC (rev 43933)
+++ branches/5.0/src/wp-includes/wp-db.php 2018-11-22 03:58:19 UTC (rev 43934)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2456,8 +2456,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $new_array = array();
</span><span class="cx" style="display: block; padding: 0 10px"> // Extract the column values
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- for ( $i = 0, $j = count( $this->last_result ); $i < $j; $i++ ) {
- $new_array[$i] = $this->get_var( null, $x, $i );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $this->last_result ) {
+ for ( $i = 0, $j = count( $this->last_result ); $i < $j; $i++ ) {
+ $new_array[ $i ] = $this->get_var( null, $x, $i );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> return $new_array;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2497,11 +2499,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $output == OBJECT_K ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Return an array of row objects with keys from column 1
</span><span class="cx" style="display: block; padding: 0 10px"> // (Duplicates are discarded)
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $this->last_result as $row ) {
- $var_by_ref = get_object_vars( $row );
- $key = array_shift( $var_by_ref );
- if ( ! isset( $new_array[ $key ] ) )
- $new_array[ $key ] = $row;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $this->last_result ) {
+ foreach ( $this->last_result as $row ) {
+ $var_by_ref = get_object_vars( $row );
+ $key = array_shift( $var_by_ref );
+ if ( ! isset( $new_array[ $key ] ) ) {
+ $new_array[ $key ] = $row;
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> return $new_array;
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $output == ARRAY_A || $output == ARRAY_N ) {
</span></span></pre></div>
<a id="branches50testsphpunittestsdbphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/tests/phpunit/tests/db.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/tests/db.php 2018-11-22 03:20:30 UTC (rev 43933)
+++ branches/5.0/tests/phpunit/tests/db.php 2018-11-22 03:58:19 UTC (rev 43934)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -156,7 +156,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_like_query
</span><span class="cx" style="display: block; padding: 0 10px"> * @param $data string The haystack, raw.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param $like string The like phrase, raw.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param $result string The expected comparison result; '1' = true, '0' = false
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param $result string The expected comparison result; '1' = true, '0' = false
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_like_query( $data, $like, $result ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -559,6 +559,96 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'Walter Sobchak', $row->display_name );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Test the `get_col()` method.
+ *
+ * @param string|null $query The query to run.
+ * @param string|array $expected The expected resulting value.
+ * @param arrray|string|null $last_result The value to assign to `$wpdb->last_result`.
+ * @param int|string $column The column index to retrieve.
+ *
+ * @dataProvider data_test_get_col
+ *
+ * @ticket 45299
+ */
+ function test_get_col( $query, $expected, $last_result, $column ) {
+ global $wpdb;
+
+ $wpdb->last_result = $last_result;
+
+ $result = $wpdb->get_col( $query, $column );
+
+ if ( $query ) {
+ $this->assertSame( $query, $wpdb->last_query );
+ }
+
+ if ( is_array( $expected ) ) {
+ $this->assertSame( $expected, $result );
+ } else {
+ $this->assertContains( $expected, $result );
+ }
+ }
+
+ /**
+ * Data provider for testing `get_col()`.
+ *
+ * @return array {
+ * Arguments for testing `get_col()`.
+ *
+ * @type string|null $query The query to run.
+ * @type string|array $expected The resulting expected value.
+ * @type arrray|string|null $last_result The value to assign to `$wpdb->last_result`.
+ * @type int|string $column The column index to retrieve.
+ */
+ function data_test_get_col() {
+ global $wpdb;
+
+ return array(
+ array(
+ "SELECT display_name FROM $wpdb->users",
+ 'admin',
+ array(),
+ 0,
+ ),
+ array(
+ "SELECT user_login, user_email FROM $wpdb->users",
+ 'admin',
+ array(),
+ 0,
+ ),
+ array(
+ "SELECT user_login, user_email FROM $wpdb->users",
+ 'admin@example.org',
+ array(),
+ 1,
+ ),
+ array(
+ "SELECT user_login, user_email FROM $wpdb->users",
+ 'admin@example.org',
+ array(),
+ '1',
+ ),
+ array(
+ "SELECT user_login, user_email FROM $wpdb->users",
+ array( null ),
+ array(),
+ 3,
+ ),
+ array(
+ '',
+ array(),
+ null,
+ 0,
+ ),
+ array(
+ null,
+ array(),
+ '',
+ 0
+ ),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_replace() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px"> $rows1 = $wpdb->insert( $wpdb->users, array( 'display_name' => 'Walter Sobchak' ) );
</span></span></pre>
</div>
</div>
</body>
</html>