Changeset 13401

Timestamp:

01/08/2023 11:03:12 PM (2 years ago)

Author:

espellcaste

Message:

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 #8697

Location:

trunk

Files:

• src/bp-messages/bp-messages-cache.php (modified) (2 diffs)
• src/bp-messages/classes/class-bp-messages-thread.php (modified) (4 diffs)
• tests/phpunit/testcases/messages/class.bp-messages-thread.php (modified) (1 diff)

trunk/src/bp-messages/bp-messages-cache.php

@@ -58 +58 @@
     wp_cache_delete( $message->thread_id, 'bp_messages_threads' );
 
+    // Delete thread messages count.
+    wp_cache_delete( "{$message->thread_id}_bp_messages_thread_total_count", 'bp_messages_threads' );
+
     // Delete unread count for each recipient.
     foreach ( (array) $message->recipients as $recipient ) {
@@ -82 +85 @@
         wp_cache_delete( $thread_id, 'bp_messages_threads' );
         wp_cache_delete( "thread_recipients_{$thread_id}", 'bp_messages' );
+
+        // Delete thread messages count.
+        wp_cache_delete( "{$thread_id}_bp_messages_thread_total_count", 'bp_messages_threads' );
     }
 

trunk/src/bp-messages/classes/class-bp-messages-thread.php

@@ -27 +27 @@
 
     /**
-     * The current messages.
+     * The current messages in the message thread.
      *
      * @since 1.0.0
@@ -33 +33 @@
      */
     public $messages;
+
+    /**
+     * The current messages count in the message thread.
+     *
+     * @since 12.0.0
+     * @var int
+     */
+    public $messages_total_count;
 
     /**
@@ -189 +197 @@
             return false;
         }
+
+        // Messages total count.
+        $this->messages_total_count = self::get_total_thread_message_count( $this->thread_id );
 
         $last_message_index         = count( $this->messages ) - 1;
@@ -941 +952 @@
 
     /**
+     * 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 );
+    }
+
+    /**
      * Determine if the logged-in user is a sender of any message in a thread.
      *

trunk/tests/phpunit/testcases/messages/class.bp-messages-thread.php

@@ -89 +89 @@
         $this->assertEquals( $u1, $messages[0]->sender_id );
         $this->assertEquals( 'Last Message', $messages[0]->subject );
+    }
+
+    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 );
+    }
+
+    /**
+     * @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' ) );
     }