Changeset 12134

Timestamp:

05/26/2018 12:49:25 PM (8 years ago)

Author:

imath

Message:

Messages UI: Create a new Backbone view to wrap hooks caught output

This new view can be used when hooks caught output cannot be inserted into regular views. bp_before_member_messages_loop and bp_before_member_messages_loop are two good examples.

Fixes #7850 (Branch 3.0)

Location:

branches/3.0/src/bp-templates/bp-nouveau

Files:

• buddypress/common/js-templates/messages/index.php (modified) (1 diff)
• includes/messages/ajax.php (modified) (4 diffs)
• js/buddypress-messages.js (modified) (5 diffs)

branches/3.0/src/bp-templates/bp-nouveau/buddypress/common/js-templates/messages/index.php

@@ -20 +20 @@
         <p>{{{data.message}}}</p>
     </div>
+</script>
+
+<?php
+/**
+ * This view is used to inject hooks buffer
+ */
+?>
+<script type="text/html" id="tmpl-bp-messages-hook">
+    {{{data.extraContent}}}
 </script>
 

branches/3.0/src/bp-templates/bp-nouveau/includes/messages/ajax.php

@@ -224 +224 @@
     }
 
-    if ( isset( $_POST['box'] ) && 'starred' === $_POST['box'] ) {
-        $star_filter = true;
-
-        // Add the message thread filter.
+    $bp           = buddypress();
+    $reset_action = $bp->current_action;
+
+    // Override bp_current_action().
+    if ( isset( $_POST['box'] ) ) {
+        $bp->current_action = $_POST['box'];
+    }
+
+    // Add the message thread filter.
+    if ( 'starred' === $bp->current_action ) {
         add_filter( 'bp_after_has_message_threads_parse_args', 'bp_messages_filter_starred_message_threads' );
     }
@@ -233 +239 @@
     // Simulate the loop.
     if ( ! bp_has_message_threads( bp_ajax_querystring( 'messages' ) ) ) {
+        // Remove the bp_current_action() override.
+        $bp->current_action = $reset_action;
+
         wp_send_json_error( array(
             'feedback' => __( 'Sorry, no messages were found.', 'buddypress' ),
@@ -239 +248 @@
     }
 
-    if ( ! empty( $star_filter ) ) {
-        // remove the message thread filter.
+    // remove the message thread filter.
+    if ( 'starred' === $bp->current_action ) {
         remove_filter( 'bp_after_has_message_threads_parse_args', 'bp_messages_filter_starred_message_threads' );
     }
@@ -320 +329 @@
     $threads->threads = array_filter( $threads->threads );
 
+    $extra_content = bp_nouveau_messages_catch_hook_content( array(
+        'beforeLoop' => 'bp_before_member_messages_loop',
+        'afterLoop'  => 'bp_after_member_messages_loop',
+    ) );
+
+    if ( array_filter( $extra_content ) ) {
+        $threads->extraContent = $extra_content;
+    }
+
+    // Remove the bp_current_action() override.
+    $bp->current_action = $reset_action;
+
+    // Return the successfull reply.
     wp_send_json_success( $threads );
 }

branches/3.0/src/bp-templates/bp-nouveau/js/buddypress-messages.js

@@ -355 +355 @@
             }
 
+            if ( ! _.isUndefined( resp.extraContent ) ) {
+                _.extend( this.options, _.pick( resp.extraContent, [
+                    'beforeLoop',
+                    'afterLoop'
+                ] ) );
+            }
+
             return resp.threads;
         },
@@ -467 +474 @@
     } );
 
+    // Hook view
+    bp.Views.Hook = bp.Nouveau.Messages.View.extend( {
+        tagName: 'div',
+        template  : bp.template( 'bp-messages-hook' ),
+
+        initialize: function() {
+            this.model = new Backbone.Model( {
+                extraContent: this.options.extraContent
+            } );
+
+            this.el.className = 'bp-messages-hook';
+
+            if ( this.options.className ) {
+                this.el.className += ' ' + this.options.className;
+            }
+        }
+    } );
+
     bp.Views.messageEditor = bp.Nouveau.Messages.View.extend( {
         template  : bp.template( 'bp-messages-editor' ),
@@ -643 +668 @@
 
         initialize: function() {
-            // Add the threads parent view
-            this.views.add( new bp.Nouveau.Messages.View( { tagName: 'ul', id: 'message-threads', className: 'message-lists' } ) );
-
-            // Add the preview Active Thread view
-            this.views.add( new bp.Views.previewThread( { collection: this.collection } ) );
+            var Views = [
+                new bp.Nouveau.Messages.View( { tagName: 'ul', id: 'message-threads', className: 'message-lists' } ),
+                new bp.Views.previewThread( { collection: this.collection } )
+            ];
+
+            _.each( Views, function( view ) {
+                this.views.add( view );
+            }, this );
 
             // Load threads for the active view
@@ -663 +691 @@
             this.collection.fetch( {
                 data    : _.pick( this.options, 'box' ),
-                success : this.threadsFetched,
+                success : _.bind( this.threadsFetched, this ),
                 error   : this.threadsFetchError
             } );
@@ -670 +698 @@
         threadsFetched: function() {
             bp.Nouveau.Messages.removeFeedback();
+
+            // Display the bp_after_member_messages_loop hook.
+            if ( this.collection.options.afterLoop ) {
+                this.views.add( new bp.Views.Hook( { extraContent: this.collection.options.afterLoop, className: 'after-messages-loop' } ), { at: 1 } );
+            }
+
+            // Display the bp_before_member_messages_loop hook.
+            if ( this.collection.options.beforeLoop ) {
+                this.views.add( new bp.Views.Hook( { extraContent: this.collection.options.beforeLoop, className: 'before-messages-loop' } ), { at: 0 } );
+            }
 
             // Inform the user about how to use the UI.