Changeset 5773 for trunk/bp-messages/bp-messages-template.php

Timestamp:

02/13/2012 03:44:13 PM (14 years ago)

Author:

johnjamesjacoby

Message:

Tweak bp_message_is_active_notice() usage. Introduce bp_messages_is_active_notice() to maintain backpat. Fixes #3970. Props hnla, paulgibbs.

File:

• trunk/bp-messages/bp-messages-template.php (modified) (5 diffs)

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

@@ -123 +123 @@
 
         function the_message_thread() {
-                global $bp;
 
                 $this->in_the_loop = true;
-                $this->thread = $this->next_thread();
+                $this->thread      = $this->next_thread();
 
                 if ( ! bp_is_current_action( 'notices' ) ) {
-                        $last_message_index = count( $this->thread->messages ) - 1;
+                        $last_message_index     = count( $this->thread->messages ) - 1;
                         $this->thread->messages = array_reverse( (array) $this->thread->messages );
 
@@ -152 +151 @@
                         }
 
-                        $this->thread->last_message_id = $this->thread->messages[$last_message_index]->id;
-                        $this->thread->last_message_date = $this->thread->messages[$last_message_index]->date_sent;
-                        $this->thread->last_sender_id = $this->thread->messages[$last_message_index]->sender_id;
+                        $this->thread->last_message_id      = $this->thread->messages[$last_message_index]->id;
+                        $this->thread->last_message_date    = $this->thread->messages[$last_message_index]->date_sent;
+                        $this->thread->last_sender_id       = $this->thread->messages[$last_message_index]->sender_id;
                         $this->thread->last_message_subject = $this->thread->messages[$last_message_index]->subject;
                         $this->thread->last_message_content = $this->thread->messages[$last_message_index]->message;
                 }
 
-                if ( 0 == $this->current_thread ) // loop has just started
+                // loop has just started
+                if ( 0 == $this->current_thread ) {
                         do_action('messages_box_loop_start');
+                }
         }
 }
@@ -185 +186 @@
                 }
 
-                if ( bp_is_current_action( 'sentbox' ) )
+                if ( bp_is_current_action( 'sentbox' ) ) {
                         $box = 'sentbox';
-
-                if ( bp_is_current_action( 'notices' ) )
+                }
+
+                if ( bp_is_current_action( 'notices' ) ) {
                         $box = 'notices';
+                }
 
                 $messages_template = new BP_Messages_Box_Template( $user_id, $box, $per_page, $max, $type );
@@ -406 +409 @@
 
 function bp_messages_options() {
-        global $bp; ?>
+?>
 
         <?php _e( 'Select:', 'buddypress' ) ?>
@@ -429 +432 @@
 }
 
+/**
+ * Return whether or not the notice is currently active
+ *
+ * @since BuddyPress (1.6)
+ * @uses bp_get_messages_is_active_notice()
+ */
+function bp_messages_is_active_notice() {
+        global $messages_template;
+
+        if ( $messages_template->thread->is_active )
+                return true;
+
+        return false;
+}
+
+/**
+ * Output a string for the active notice
+ *
+ * Since 1.6 this function has been deprecated in favor of text in the theme
+ *
+ * @since BuddyPress (1.0)
+ * @deprecated BuddyPress (1.6)
+ * @uses bp_get_message_is_active_notice()
+ */
 function bp_message_is_active_notice() {
-        global $messages_template;
-
-        if ( $messages_template->thread->is_active ) {
-                echo "<strong>";
-                _e( 'Currently Active', 'buddypress' );
-                echo "</strong>";
-        }
-}
+        echo bp_get_message_is_active_notice();
+}
+        /**
+         * Returns a string for the active notice
+         *
+         * Since 1.6 this function has been deprecated in favor of text in the theme
+         *
+         * @since BuddyPress (1.0)
+         * @deprecated BuddyPress (1.6)
+         * @uses bp_messages_is_active_notice()
+         */
         function bp_get_message_is_active_notice() {
-                global $messages_template;
-
-                if ( $messages_template->thread->is_active )
-                        return true;
-
-                return false;
+
+                $string = '';
+                if ( bp_messages_is_active_notice() )
+                        $string = __( 'Currently Active', 'buddypress' );
+
+                return apply_filters( 'bp_get_message_is_active_notice', $string );
         }