Changeset 9204

Timestamp:

11/29/2014 04:04:42 PM (10 years ago)

Author:

boonebgorges

Message:

Create an activity item when a group's details are updated.

When a name or description alone are updated, the activity item will display
the "from" and "to" values as part of the formatted activity action string. If
both items have been changed, the activity action will read "x changed the name
and description of the group y".

Fixes #5880.

Location:

trunk

Files:

• src/bp-groups/bp-groups-activity.php (modified) (3 diffs)
• src/bp-groups/bp-groups-functions.php (modified) (2 diffs)
• tests/phpunit/testcases/groups/activity.php (modified) (1 diff)

trunk/src/bp-groups/bp-groups-activity.php

@@ -41 +41 @@
         'bp_groups_format_activity_action_joined_group',
         __( 'Group Memberships', 'buddypress' ),
+        array( 'activity', 'group', 'member', 'member_groups' )
+    );
+
+    bp_activity_set_action(
+        $bp->groups->id,
+        'group_details_updated',
+        __( 'Group details edited', 'buddypress' ),
+        'bp_groups_format_activity_action_group_details_updated',
+        __( 'Group Updates', 'buddypress' ),
         array( 'activity', 'group', 'member', 'member_groups' )
     );
@@ -129 +138 @@
 
 /**
+ * Format 'group_details_updated' activity actions.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param  string $action   Static activity action.
+ * @param  object $activity Activity data object.
+ * @return string
+ */
+function bp_groups_format_activity_action_group_details_updated( $action, $activity ) {
+    $user_link = bp_core_get_userlink( $activity->user_id );
+
+    $group = groups_get_group( array(
+        'group_id'        => $activity->item_id,
+        'populate_extras' => false,
+    ) );
+    $group_link = '<a href="' . esc_url( bp_get_group_permalink( $group ) ) . '">' . esc_html( $group->name ) . '</a>';
+
+    /*
+     * Changed group details are stored in groupmeta, keyed by the activity
+     * timestamp. See {@link bp_groups_group_details_updated_add_activity()}.
+     */
+    $changed = groups_get_groupmeta( $activity->item_id, 'updated_details_' . $activity->date_recorded );
+
+    // No changed details were found, so use a generic message.
+    if ( empty( $changed ) ) {
+        $action = sprintf( __( '%1$s updated details for the group %2$s', 'buddypress' ), $user_link, $group_link );
+
+    // Name and description changed - to keep things short, don't describe changes in detail.
+    } else if ( isset( $changed['name'] ) && isset( $changed['description'] ) ) {
+        $action = sprintf( __( '%1$s changed the name and description of the group %2$s', 'buddypress' ), $user_link, $group_link );
+
+    // Name only.
+    } else if ( ! empty( $changed['name']['old'] ) && ! empty( $changed['name']['new'] ) ) {
+        $action = sprintf( __( '%1$s changed the name of the group %2$s from "%3$s" to "%4$s"', 'buddypress' ), $user_link, $group_link, esc_html( $changed['name']['old'] ), esc_html( $changed['name']['new'] ) );
+
+    // Description only.
+    } else if ( ! empty( $changed['description']['old'] ) && ! empty( $changed['description']['new'] ) ) {
+        $action = sprintf( __( '%1$s changed the description of the group %2$s from "%3$s" to "%4$s"', 'buddypress' ), $user_link, $group_link, esc_html( $changed['description']['old'] ), esc_html( $changed['description']['new'] ) );
+
+    }
+
+    return apply_filters( 'bp_groups_format_activity_action_joined_group', $action, $activity );
+}
+
+/**
  * Fetch data related to groups at the beginning of an activity loop.
  *
@@ -291 +345 @@
 
 /**
+ * Add an activity item when a group's details are updated.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param  int             $group_id       ID of the group.
+ * @param  BP_Groups_Group $old_grop       Group object before the details had been changed.
+ * @param  bool            $notify_members True if the admin has opted to notify group members, otherwise false.
+ * @return int|bool The ID of the activity on success. False on error.
+ */
+function bp_groups_group_details_updated_add_activity( $group_id, $old_group, $notify_members ) {
+
+    // Bail if Activity is not active.
+    if ( ! bp_is_active( 'activity' ) ) {
+        return false;
+    }
+
+    if ( ! isset( $old_group->name ) || ! isset( $old_group->description ) ) {
+        return false;
+    }
+
+    // If the admin has opted not to notify members, don't post an activity item either
+    if ( empty( $notify_members ) ) {
+        return;
+    }
+
+    $group = groups_get_group( array(
+        'group_id' => $group_id,
+    ) );
+
+    /*
+     * Store the changed data, which will be used to generate the activity
+     * action. Since we haven't yet created the activity item, we store the
+     * old group data in groupmeta, keyed by the timestamp that we'll put
+     * on the activity item.
+     */
+    $changed = array();
+
+    if ( $group->name !== $old_group->name ) {
+        $changed['name'] = array(
+            'old' => $old_group->name,
+            'new' => $group->name,
+        );
+    }
+
+    if ( $group->description !== $old_group->description ) {
+        $changed['description'] = array(
+            'old' => $old_group->description,
+            'new' => $group->description,
+        );
+    }
+
+    // If there are no changes, don't post an activity item.
+    if ( empty( $changed ) ) {
+        return;
+    }
+
+    $time = bp_core_current_time();
+    groups_update_groupmeta( $group_id, 'updated_details_' . $time, $changed );
+
+    // Record in activity streams.
+    return groups_record_activity( array(
+        'type'          => 'group_details_updated',
+        'item_id'       => $group_id,
+        'user_id'       => bp_loggedin_user_id(),
+        'recorded_time' => $time,
+
+    ) );
+
+}
+add_action( 'groups_details_updated', 'bp_groups_group_details_updated_add_activity', 10, 3 );
+
+/**
  * Delete all activity items related to a specific group.
  *

trunk/src/bp-groups/bp-groups-functions.php

@@ -191 +191 @@
         return false;
 
-    $group              = groups_get_group( array( 'group_id' => $group_id ) );
+    $group     = groups_get_group( array( 'group_id' => $group_id ) );
+    $old_group = clone $group;
+
     $group->name        = $group_name;
     $group->description = $group_desc;
@@ -202 +204 @@
     }
 
-    do_action( 'groups_details_updated', $group->id );
+    /**
+     * Fired after a group's details are updated.
+     *
+     * @since BuddyPress (2.2.0)
+     *
+     * @param int             $value          ID of the group.
+     * @param BP_Groups_Group $old_group      Group object, before being modified.
+     * @param bool            $notify_members Whether to send an email notification to members about the change.
+     */
+    do_action( 'groups_details_updated', $group->id, $old_group, $notify_members );
 
     return true;

trunk/tests/phpunit/testcases/groups/activity.php

@@ -49 +49 @@
         $this->assertSame( $expected, $a_obj->action );
     }
+
+    /**
+     * @group activity_action
+     * @group bp_groups_format_activity_action_group_details_updated
+     */
+    public function test_bp_groups_format_activity_action_group_details_updated_with_no_change() {
+        $group = $this->factory->group->create_and_get();
+        groups_edit_base_group_details( $group->id, $group->name, $group->description, true );
+
+        $a = bp_activity_get( array(
+            'component' => buddypress()->groups->id,
+            'action' => 'group_details_updated',
+            'item_id' => $group->id,
+        ) );
+
+        $this->assertTrue( empty( $a['activities'] ) );
+    }
+
+    /**
+     * @group activity_action
+     * @group bp_groups_format_activity_action_group_details_updated
+     */
+    public function test_bp_groups_format_activity_action_group_details_updated_with_notify_members_false() {
+        $group = $this->factory->group->create_and_get();
+        groups_edit_base_group_details( $group->id, 'Foo', $group->description, false );
+
+        $a = bp_activity_get( array(
+            'component' => buddypress()->groups->id,
+            'action' => 'group_details_updated',
+            'item_id' => $group->id,
+        ) );
+
+        $this->assertTrue( empty( $a['activities'] ) );
+    }
+
+    /**
+     * @group activity_action
+     * @group bp_groups_format_activity_action_group_details_updated
+     */
+    public function test_bp_groups_format_activity_action_group_details_updated_with_updated_name() {
+        $old_user = get_current_user_id();
+        $u = $this->factory->user->create();
+        $this->set_current_user( $u );
+
+        $group = $this->factory->group->create_and_get();
+        groups_edit_base_group_details( $group->id, 'Foo', $group->description, true );
+
+        $a = bp_activity_get( array(
+            'component' => buddypress()->groups->id,
+            'action' => 'group_details_updated',
+            'item_id' => $group->id,
+        ) );
+
+        $this->assertNotEmpty( $a['activities'] );
+
+        $expected = sprintf( __( '%s changed the name of the group %s from "%s" to "%s"', 'buddypress' ), bp_core_get_userlink( $u ),  '<a href="' . bp_get_group_permalink( $group ) . '">Foo</a>', $group->name, 'Foo' );
+        $this->assertSame( $expected, $a['activities'][0]->action );
+
+        $this->set_current_user( $old_user );
+    }
+
+    /**
+     * @group activity_action
+     * @group bp_groups_format_activity_action_group_details_updated
+     */
+    public function test_bp_groups_format_activity_action_group_details_updated_with_updated_description() {
+        $old_user = get_current_user_id();
+        $u = $this->factory->user->create();
+        $this->set_current_user( $u );
+
+        $group = $this->factory->group->create_and_get();
+        groups_edit_base_group_details( $group->id, $group->name, 'Bar', true );
+
+        $a = bp_activity_get( array(
+            'component' => buddypress()->groups->id,
+            'action' => 'group_details_updated',
+            'item_id' => $group->id,
+        ) );
+
+        $this->assertNotEmpty( $a['activities'] );
+
+        $expected = sprintf( __( '%s changed the description of the group %s from "%s" to "%s"', 'buddypress' ), bp_core_get_userlink( $u ),  '<a href="' . bp_get_group_permalink( $group ) . '">' . $group->name . '</a>', $group->description, 'Bar' );
+        $this->assertSame( $expected, $a['activities'][0]->action );
+
+        $this->set_current_user( $old_user );
+    }
+
+    /**
+     * @group activity_action
+     * @group bp_groups_format_activity_action_group_details_updated
+     */
+    public function test_bp_groups_format_activity_action_group_details_updated_with_updated_name_and_description() {
+        $old_user = get_current_user_id();
+        $u = $this->factory->user->create();
+        $this->set_current_user( $u );
+
+        $group = $this->factory->group->create_and_get();
+        groups_edit_base_group_details( $group->id, 'Foo', 'Bar', true );
+
+        $a = bp_activity_get( array(
+            'component' => buddypress()->groups->id,
+            'action' => 'group_details_updated',
+            'item_id' => $group->id,
+        ) );
+
+        $this->assertNotEmpty( $a['activities'] );
+
+        $expected = sprintf( __( '%s changed the name and description of the group %s', 'buddypress' ), bp_core_get_userlink( $u ),  '<a href="' . bp_get_group_permalink( $group ) . '">Foo</a>' );
+        $this->assertSame( $expected, $a['activities'][0]->action );
+
+        $this->set_current_user( $old_user );
+    }
 }