Changeset 10910

Timestamp:

06/28/2016 05:23:49 PM (8 years ago)

Author:

r-a-y

Message:

Notifications: Fix issue with querying notifications by string format.

If someone is using:
bp_notifications_get_notifications_for_user( $user_id, 'string' )

This functionality broke in #7066.

Commit fixes this issue and includes unit tests.

Fixes #7141 (2.6-branch).

Location:

branches/2.6

Files:

• src/bp-notifications/bp-notifications-functions.php (modified) (1 diff)
• tests/phpunit/testcases/notifications/functions.php (modified) (1 diff)

branches/2.6/src/bp-notifications/bp-notifications-functions.php

@@ -255 +255 @@
                 // Return an array of content strings.
                 } else {
-                    $content      = call_user_func( $bp->{$component_name}->notification_callback, $component_action_name, $component_action_items[0]->item_id, $component_action_items[0]->secondary_item_id, $action_item_count, $component_action_items[0]->id );
+                    $content      = call_user_func( $bp->{$component_name}->notification_callback, $component_action_name, $component_action_items[0]->item_id, $component_action_items[0]->secondary_item_id, $action_item_count, 'string', $component_action_items[0]->id );
                     $renderable[] = $content;
                 }

branches/2.6/tests/phpunit/testcases/notifications/functions.php

@@ -349 +349 @@
         $this->assertEmpty( $found2 );
     }
+
+    /**
+     * @group  notification_callback
+     * @ticket BP7141
+     */
+    public function test_notification_callback_parameter_integrity() {
+        $u = $this->factory->user->create();
+
+        $n = $this->factory->notification->create( array(
+            'component_name'    => 'activity',
+            'component_action'  => 'new_at_mention',
+            'item_id'           => 99,
+            'user_id'           => $u,
+        ) );
+
+        // Override activity notification callback so we can test integrity.
+        buddypress()->activity->notification_callback = array( $this, 'dummy_notification_callback' );
+
+        // Fetch notifications with string format.
+        bp_notifications_get_notifications_for_user( $u, 'string' );
+
+        // Assert!
+        // @todo When we cast all numeric strings as integers, this needs to be changed.
+        $expected = array(
+            'action'            => 'new_at_mention',
+            'item_id'           => '99',
+            'secondary_item_id' => '0',
+            'total_items'       => 1,
+            'id'                => (string) $n,
+            'format'            => 'string'
+        );
+        $this->assertEquals( $expected, $this->n_args );
+
+        // Fetch notifications with object format this time.
+        bp_notifications_get_notifications_for_user( $u, 'object' );
+
+        // Assert!
+        $expected['format'] = 'array';
+        $this->assertEquals( $expected, $this->n_args );
+
+        // Reset!
+        buddypress()->activity->notification_callback = 'bp_activity_format_notifications';
+        unset( $this->n_args );
+    }
+
+    /**
+     * Used in test_notification_callback_parameter_integrity() test.
+     */
+    public function dummy_notification_callback( $action, $item_id, $secondary_item_id, $total_items, $format = 'string', $id = 0 ) {
+        $this->n_args = compact( 'action', 'item_id', 'secondary_item_id', 'total_items', 'id', 'format' );
+    }
 }