Changeset 9208

Timestamp:

12/03/2014 03:27:09 PM (10 years ago)

Author:

boonebgorges

Message:

Assemble message notification filters dynamically.

This allows us to centralize the documentation.

Props tw2113.
See #5970.

Location:

trunk

Files:

• src/bp-messages/bp-messages-notifications.php (modified) (3 diffs)
• tests/phpunit/testcases/messages/notifications.php (modified) (2 diffs)

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

@@ -129 +129 @@
     if ( 'new_message' === $action ) {
         if ( $total_items > 1 ) {
+            $amount = 'multiple';
             $text   = sprintf( __( 'You have %d new messages', 'buddypress' ), $total_items );
-            $filter = 'bp_messages_multiple_new_message_notification';
         } else {
+            $amount = 'single';
+
             // get message thread ID
             $message   = new BP_Messages_Message( $item_id );
@@ -144 +146 @@
                 $text = sprintf( _n( 'You have %s new private message', 'You have %s new private messages', $total_items, 'buddypress' ), bp_core_number_format( $total_items ) );
             }
-            $filter = 'bp_messages_single_new_message_notification';
         }
     }
@@ -154 +155 @@
             $retval = esc_html( $text );
         }
-        $return = apply_filters( $filter, $retval, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+
+        /**
+         * Filters the new message notification text before the notification is created.
+         *
+         * This is a dynamic filter. Possible filter names are:
+         *   - 'bp_messages_multiple_new_message_notification'
+         *   - 'bp_messages_single_new_message_notification'
+         *
+         * @param string $retval            Notification text.
+         * @param int    $total_items       Number of messages referred to by the notification.
+         * @param string $text              The raw notification test (ie, not wrappen in a link).
+         * @param int    $item_id           ID of the associated item.
+         * @param int    $secondary_item_id ID of the secondary associated item.
+         */
+        $return = apply_filters( 'bp_messages_' . $amount . '_new_message_notification', $retval, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
     } else {
-        $return = apply_filters( $filter, array(
+        /** This filter is documented in bp-messages/bp-messages-notifications.php */
+        $return = apply_filters( 'bp_messages_' . $amount . '_new_message_notification', array(
             'text' => $text,
             'link' => $link

trunk/tests/phpunit/testcases/messages/notifications.php

@@ -6 +6 @@
  */
 class BP_Tests_Messages_Notifications extends BP_UnitTestCase {
+
+    protected $filter_fired;
+
+    public function setUp() {
+        parent::setUp();
+
+        $this->filter_fired = '';
+    }
     /**
      * @group bp_messages_message_delete_notifications
@@ -43 +51 @@
         $this->set_current_user( $current_user );
     }
+
+    /**
+     * @group messages_format_notifications
+     */
+    public function test_friends_format_notifications_bp_messages_multiple_new_message_notification_nonstring_filter() {
+        // Dummy thread ID
+        $t = 12;
+        $u = $this->factory->user->create();
+        $this->set_current_user( $u );
+
+        // Admin
+        $n = $this->factory->notification->create( array(
+            'component_name' => 'messages',
+            'user_id' => $u,
+            'item_id' => $t,
+            'component_action' => 'new_message',
+        ) );
+
+        add_filter( 'bp_messages_multiple_new_message_notification', array( $this, 'notification_filter_callback' ) );
+        $n = messages_format_notifications( 'new_message', $n, '', 2, 'array' );
+        remove_filter( 'bp_messages_multiple_new_message_notification', array( $this, 'notification_filter_callback' ) );
+
+        $this->assertSame( 'bp_messages_multiple_new_message_notification', $this->filter_fired );
+    }
+
+    /**
+     * @group messages_format_notifications
+     */
+    public function test_friends_format_notifications_bp_messages_single_new_message_notification_nonstring_filter() {
+        // Dummy thread ID
+        $t = 12;
+        $u = $this->factory->user->create();
+        $this->set_current_user( $u );
+
+        // Admin
+        $n = $this->factory->notification->create( array(
+            'component_name' => 'messages',
+            'user_id' => $u,
+            'item_id' => $t,
+            'component_action' => 'new_message',
+        ) );
+
+        add_filter( 'bp_messages_single_new_message_notification', array( $this, 'notification_filter_callback' ) );
+        $n = messages_format_notifications( 'new_message', $n, '', 1, 'array' );
+        remove_filter( 'bp_messages_single_new_message_notification', array( $this, 'notification_filter_callback' ) );
+
+        $this->assertSame( 'bp_messages_single_new_message_notification', $this->filter_fired );
+    }
+
+    /**
+     * @group messages_format_notifications
+     */
+    public function test_friends_format_notifications_bp_messages_multiple_new_message_notification_string_filter() {
+        // Dummy thread ID
+        $t = 12;
+        $u = $this->factory->user->create();
+        $this->set_current_user( $u );
+
+        // Admin
+        $n = $this->factory->notification->create( array(
+            'component_name' => 'messages',
+            'user_id' => $u,
+            'item_id' => $t,
+            'component_action' => 'new_message',
+        ) );
+
+        add_filter( 'bp_messages_multiple_new_message_notification', array( $this, 'notification_filter_callback' ) );
+        $n = messages_format_notifications( 'new_message', $n, '', 2 );
+        remove_filter( 'bp_messages_multiple_new_message_notification', array( $this, 'notification_filter_callback' ) );
+
+        $this->assertSame( 'bp_messages_multiple_new_message_notification', $this->filter_fired );
+    }
+
+    /**
+     * @group messages_format_notifications
+     */
+    public function test_friends_format_notifications_bp_messages_single_new_message_notification_string_filter() {
+        // Dummy thread ID
+        $t = 12;
+        $u = $this->factory->user->create();
+        $this->set_current_user( $u );
+
+        // Admin
+        $n = $this->factory->notification->create( array(
+            'component_name' => 'messages',
+            'user_id' => $u,
+            'item_id' => $t,
+            'component_action' => 'new_message',
+        ) );
+
+        add_filter( 'bp_messages_single_new_message_notification', array( $this, 'notification_filter_callback' ) );
+        $n = messages_format_notifications( 'new_message', $n, '', 1 );
+        remove_filter( 'bp_messages_single_new_message_notification', array( $this, 'notification_filter_callback' ) );
+
+        $this->assertSame( 'bp_messages_single_new_message_notification', $this->filter_fired );
+    }
+
+    public function notification_filter_callback( $value ) {
+        $this->filter_fired = current_filter();
+        return $value;
+    }
 }