<!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>[BuddyPress][13401] trunk: `BP_Messages_Thread`: return the total number of messages in a thread.</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="http://buddypress.trac.wordpress.org/changeset/13401">13401</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/13401","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>espellcaste</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-01-08 23:03:12 +0000 (Sun, 08 Jan 2023)</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'>`BP_Messages_Thread`: return the total number of messages in a thread.
Introducing a new property `$messages_total_count` to the `BP_Messages_Thread` class which returns the total number of messages in a thread.
Closes https://github.com/buddypress/buddypress/pull/51
Fixews <a href="http://buddypress.trac.wordpress.org/ticket/8697">#8697</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmessagesbpmessagescachephp">trunk/src/bp-messages/bp-messages-cache.php</a></li>
<li><a href="#trunksrcbpmessagesclassesclassbpmessagesthreadphp">trunk/src/bp-messages/classes/class-bp-messages-thread.php</a></li>
<li><a href="#trunktestsphpunittestcasesmessagesclassbpmessagesthreadphp">trunk/tests/phpunit/testcases/messages/class.bp-messages-thread.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmessagesbpmessagescachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-messages/bp-messages-cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/bp-messages-cache.php 2023-01-07 02:03:01 UTC (rev 13400)
+++ trunk/src/bp-messages/bp-messages-cache.php 2023-01-08 23:03:12 UTC (rev 13401)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -57,6 +57,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Delete thread cache.
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_delete( $message->thread_id, 'bp_messages_threads' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Delete thread messages count.
+ wp_cache_delete( "{$message->thread_id}_bp_messages_thread_total_count", 'bp_messages_threads' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Delete unread count for each recipient.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $message->recipients as $recipient ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_delete( $recipient->user_id, 'bp_messages_unread_count' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,6 +84,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $thread_ids as $thread_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_delete( $thread_id, 'bp_messages_threads' );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_delete( "thread_recipients_{$thread_id}", 'bp_messages' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Delete thread messages count.
+ wp_cache_delete( "{$thread_id}_bp_messages_thread_total_count", 'bp_messages_threads' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Delete unread count for logged-in user.
</span></span></pre></div>
<a id="trunksrcbpmessagesclassesclassbpmessagesthreadphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-messages/classes/class-bp-messages-thread.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/classes/class-bp-messages-thread.php 2023-01-07 02:03:01 UTC (rev 13400)
+++ trunk/src/bp-messages/classes/class-bp-messages-thread.php 2023-01-08 23:03:12 UTC (rev 13401)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,7 +26,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $thread_id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The current messages.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The current messages in the message thread.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -34,6 +34,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $messages;
</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">+ * The current messages count in the message thread.
+ *
+ * @since 12.0.0
+ * @var int
+ */
+ public $messages_total_count;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * The current recipients in the message thread.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -189,6 +197,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">+ // Messages total count.
+ $this->messages_total_count = self::get_total_thread_message_count( $this->thread_id );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $last_message_index = count( $this->messages ) - 1;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->last_message_id = $this->messages[ $last_message_index ]->id;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->last_message_date = $this->messages[ $last_message_index ]->date_sent;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -940,6 +951,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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">+ * Returns the total number of messages in a thread.
+ *
+ * @since 12.0.0
+ *
+ * @global wpdb $wpdb WordPress database object.
+ *
+ * @param integer $thread_id The message thread ID.
+ * @return integer Total thread message count
+ */
+ public static function get_total_thread_message_count( $thread_id ) {
+ global $wpdb;
+
+ $cache_key = "{$thread_id}_bp_messages_thread_total_count";
+ $total_count = wp_cache_get( $cache_key, 'bp_messages_threads' );
+
+ if ( false === $total_count ) {
+ $bp = buddypress();
+
+ $total_count = (int) $wpdb->get_var(
+ $wpdb->prepare( "SELECT COUNT(id) FROM {$bp->messages->table_name_messages} WHERE thread_id = %d", $thread_id )
+ );
+
+ wp_cache_set( $cache_key, $total_count, 'bp_messages_threads' );
+ }
+
+ /**
+ * Thread messages count.
+ *
+ * @since 12.0.0
+ *
+ * @param integer $total_count Total thread messages count.
+ * @param integer $thread_id ID of the thread.
+ */
+ return (int) apply_filters( 'messages_thread_get_total_message_count', $total_count, (int) $thread_id );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Determine if the logged-in user is a sender of any message in a thread.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span></span></pre></div>
<a id="trunktestsphpunittestcasesmessagesclassbpmessagesthreadphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/messages/class.bp-messages-thread.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/messages/class.bp-messages-thread.php 2023-01-07 02:03:01 UTC (rev 13400)
+++ trunk/tests/phpunit/testcases/messages/class.bp-messages-thread.php 2023-01-08 23:03:12 UTC (rev 13401)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,7 +90,95 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'Last Message', $messages[0]->subject );
</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">+ public function test_get_messages_total_count() {
+ $u1 = self::factory()->user->create();
+ $u2 = self::factory()->user->create();
+ $m1 = self::factory()->message->create_and_get(
+ [
+ 'sender_id' => $u1,
+ 'recipients' => [ $u2 ],
+ 'subject' => 'Foo',
+ ]
+ );
+
+ self::factory()->message->create_many(
+ 98,
+ [
+ 'thread_id' => $m1->thread_id,
+ 'sender_id' => $u2,
+ 'recipients' => [ $u1 ],
+ 'subject' => 'Bar',
+ ]
+ );
+
+ // Last message
+ self::factory()->message->create(
+ [
+ 'thread_id' => $m1->thread_id,
+ 'sender_id' => $u1,
+ 'recipients' => [ $u2 ],
+ 'subject' => 'Last Message',
+ ]
+ );
+
+ $count = BP_Messages_Thread::get_total_thread_message_count( $m1->thread_id );
+ $this->assertSame( 100, $count );
+
+ $thread = new BP_Messages_Thread( $m1->thread_id );
+ $this->assertSame( 100, $thread->messages_total_count );
+
+ $thread = new BP_Messages_Thread( $m1->thread_id, 'ASC', [ 'page' => 1, 'per_page' => 10 ] );
+ $this->assertCount( 10, $thread->messages );
+ $this->assertSame( 100, $thread->messages_total_count );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group cache
+ */
+ public function test_get_messages_total_count_cached() {
+ $u1 = self::factory()->user->create();
+ $u2 = self::factory()->user->create();
+ $m1 = self::factory()->message->create_and_get(
+ [
+ 'sender_id' => $u1,
+ 'recipients' => [ $u2 ],
+ 'subject' => 'Foo',
+ ]
+ );
+
+ $m2 = self::factory()->message->create(
+ [
+ 'thread_id' => $m1->thread_id,
+ 'sender_id' => $u2,
+ 'recipients' => [ $u1 ],
+ 'subject' => 'Middle Message',
+ ]
+ );
+
+ $cache_key = "{$m1->thread_id}_bp_messages_thread_total_count";
+ $count = BP_Messages_Thread::get_total_thread_message_count( $m1->thread_id );
+
+ $this->assertSame( 2, $count );
+ $this->assertSame( 2, wp_cache_get( $cache_key, 'bp_messages_threads' ) );
+
+ self::factory()->message->create(
+ [
+ 'thread_id' => $m1->thread_id,
+ 'sender_id' => $u2,
+ 'recipients' => [ $u1 ],
+ 'subject' => 'Last Message',
+ ]
+ );
+
+ $this->assertSame( 3, wp_cache_get( $cache_key, 'bp_messages_threads' ) );
+
+ // Delete thread.
+ messages_delete_thread( $m1->thread_id );
+
+ $this->assertFalse( wp_cache_get( $cache_key, 'bp_messages_threads' ) );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @group order
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_construct_order_desc() {
</span></span></pre>
</div>
</div>
</body>
</html>