Changeset 9183

Timestamp:

11/26/2014 06:08:23 AM (10 years ago)

Author:

r-a-y

Message:

Prefetch message meta when in a message loop.

This reduces overhead when querying for message meta in the context of a
bp_thread_has_messages() loop.

Also introduces an 'update_meta_cache' parameter to the bp_has_thread_messages()
stack, so the message meta cache prefetch can be disabled by developers.

See #3083.

Location:

trunk/src/bp-messages

Files:

• bp-messages-classes.php (modified) (4 diffs)
• bp-messages-template.php (modified) (4 diffs)

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

@@ -110 +110 @@
      * @since BuddyPress (1.0.0)
      *
-     * @param bool|int $thread_id The message thread ID.
-     * @param string $order The order to sort the messages. Either 'ASC' or 'DESC'.
-     */
-    public function __construct( $thread_id = false, $order = 'ASC' ) {
+     * @see BP_Messages_Thread::populate() for full description of parameters
+     */
+    public function __construct( $thread_id = false, $order = 'ASC', $args = array() ) {
         if ( $thread_id ) {
-            $this->populate( $thread_id, $order );
+            $this->populate( $thread_id, $order, $args );
         }
     }
@@ -128 +127 @@
      * @param int $thread_id The message thread ID.
      * @param string $order The order to sort the messages. Either 'ASC' or 'DESC'.
+     * @param array $args {
+     *     Array of arguments.
+     *     @type bool $update_meta_cache Whether to pre-fetch metadata for
+     *           queried message items. Default: true.
+     * }
      * @return bool False on failure.
      */
-    public function populate( $thread_id, $order ) {
+    public function populate( $thread_id = 0, $order = 'ASC', $args = array() ) {
         global $wpdb, $bp;
 
         if( 'ASC' != $order && 'DESC' != $order ) {
-            $order= 'ASC';
-        }
+            $order = 'ASC';
+        }
+
+        // merge $args with our defaults
+        $r = wp_parse_args( $args, array(
+            'update_meta_cache' => true
+        ) );
 
         $this->messages_order = $order;
@@ -154 +163 @@
         if ( isset( $this->recipients[bp_loggedin_user_id()] ) ) {
             $this->unread_count = $this->recipients[bp_loggedin_user_id()]->unread_count;
+        }
+
+        // Grab all message meta
+        if ( true === (bool) $r['update_meta_cache'] ) {
+            bp_messages_update_meta_cache( wp_list_pluck( $this->messages, 'id' ) );
         }
 
@@ -326 +340 @@
         $threads = false;
         foreach ( (array) $sorted_threads as $thread_id => $date_sent ) {
-            $threads[] = new BP_Messages_Thread( $thread_id );
+            $threads[] = new BP_Messages_Thread( $thread_id, 'ASC', array(
+                'update_meta_cache' => false
+            ) );
         }
 

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

@@ -1468 +1468 @@
      * Constructor method.
      *
-     * @param int $thread_id ID of the message thread.
-     * @param string $order 'ASC' or 'DESC'.
-     */
-    public function __construct( $thread_id, $order ) {
-        $this->thread        = new BP_Messages_Thread( $thread_id, $order );
+     * @see BP_Messages_Thread::populate() for full parameter info
+     */
+    public function __construct( $thread_id, $order, $args ) {
+        $this->thread        = new BP_Messages_Thread( $thread_id, $order, $args );
         $this->message_count = count( $this->thread->messages );
 
@@ -1573 +1572 @@
  *           the URL (bp_action_variable( 0 )).
  *     @type string $order 'ASC' or 'DESC'. Default: 'ASC'.
+ *     @type bool $update_meta_cache Whether to pre-fetch metadata for
+ *           queried message items. Default: true.
  * }
  * @return bool True if there are messages to display, otherwise false.
@@ -1580 +1581 @@
 
     $r = bp_parse_args( $args, array(
-        'thread_id' => false,
-        'order'     => 'ASC'
+        'thread_id'         => false,
+        'order'             => 'ASC',
+        'update_meta_cache' => true,
     ), 'thread_has_messages' );
 
@@ -1588 +1590 @@
     }
 
-    $thread_template = new BP_Messages_Thread_Template( $r['thread_id'], $r['order'] );
+    // Set up extra args
+    $extra_args = $r;
+    unset( $extra_args['thread_id'], $extra_args['order'] );
+
+    $thread_template = new BP_Messages_Thread_Template( $r['thread_id'], $r['order'], $extra_args );
 
     return $thread_template->has_messages();