Changeset 10323 for trunk/src/bp-friends/bp-friends-activity.php

Timestamp:

11/02/2015 02:07:44 AM (9 years ago)

Author:

tw2113

Message:

More docs cleanup for Friends component.

See #6400.

File:

• trunk/src/bp-friends/bp-friends-activity.php (modified) (19 diffs)

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

@@ -91 +91 @@
     $bp = buddypress();
 
-    // These two added in BP 1.6
+    // These two added in BP 1.6.
     bp_activity_set_action(
         $bp->friends->id,
@@ -110 +110 @@
     );
 
-    // < BP 1.6 backpat
+    // < BP 1.6 backpat.
     bp_activity_set_action( $bp->friends->id, 'friends_register_activity_action', __( 'New friendship created', 'buddypress' ) );
 
@@ -129 +129 @@
  * @param string $action   Activity action string.
  * @param object $activity Activity data.
- *
  * @return string $action Formatted activity action.
  */
@@ -140 +139 @@
     // Backward compatibility for legacy filter
     // The old filter has the $friendship object passed to it. We want to
-    // avoid having to build this object if it's not necessary
+    // avoid having to build this object if it's not necessary.
     if ( has_filter( 'friends_activity_friendship_accepted_action' ) ) {
         $friendship = new BP_Friends_Friendship( $activity->item_id );
@@ -164 +163 @@
  * @param string $action   Static activity action.
  * @param object $activity Activity data.
- *
  * @return string $action Formatted activity action.
  */
@@ -175 +173 @@
     // Backward compatibility for legacy filter
     // The old filter has the $friendship object passed to it. We want to
-    // avoid having to build this object if it's not necessary
+    // avoid having to build this object if it's not necessary.
     if ( has_filter( 'friends_activity_friendship_accepted_action' ) ) {
         $friendship = new BP_Friends_Friendship( $activity->item_id );
@@ -200 +198 @@
  *
  * @param array $activities Array of activity items.
- *
  * @return array
  */
@@ -219 +216 @@
 
     if ( ! empty( $friend_ids ) ) {
-        // Fire a user query to prime user caches
+        // Fire a user query to prime user caches.
         new BP_User_Query( array(
             'user_ids'          => $friend_ids,
@@ -238 +235 @@
  * @since 2.2.0
  *
- * @param array $retval Empty array by default
- * @param array $filter Current activity arguments
- *
+ * @param array $retval Empty array by default.
+ * @param array $filter Current activity arguments.
  * @return array
  */
 function bp_friends_filter_activity_scope( $retval = array(), $filter = array() ) {
 
-    // Determine the user_id
+    // Determine the user_id.
     if ( ! empty( $filter['user_id'] ) ) {
         $user_id = $filter['user_id'];
@@ -254 +250 @@
     }
 
-    // Determine friends of user
+    // Determine friends of user.
     $friends = friends_get_friend_user_ids( $user_id );
     if ( empty( $friends ) ) {
@@ -268 +264 @@
         ),
 
-        // we should only be able to view sitewide activity content for friends
+        // We should only be able to view sitewide activity content for friends.
         array(
             'column' => 'hide_sitewide',
@@ -274 +270 @@
         ),
 
-        // overrides
+        // Overrides.
         'override' => array(
             'filter'      => array( 'user_id' => 0 ),
@@ -292 +288 @@
  * @since 2.2.0
  *
- * @param array $retval Empty array by default
- * @param array $filter Current activity arguments
+ * @param array $retval Empty array by default.
+ * @param array $filter Current activity arguments.
  *
  * @return array
@@ -299 +295 @@
 function bp_friends_filter_activity_just_me_scope( $retval = array(), $filter = array() ) {
 
-    // Determine the user_id
+    // Determine the user_id.
     if ( ! empty( $filter['user_id'] ) ) {
         $user_id = $filter['user_id'];
@@ -308 +304 @@
     }
 
-    // Get the requested action
+    // Get the requested action.
     $action = $filter['filter']['action'];
 
-    // Make sure actions are listed in an array
+    // Make sure actions are listed in an array.
     if ( ! is_array( $action ) ) {
         $action = explode( ',', $filter['filter']['action'] );
@@ -326 +322 @@
     }
 
-    // Juggle existing override value
+    // Juggle existing override value.
     $override = array();
     if ( ! empty( $retval['override'] ) ) {
@@ -354 +350 @@
     );
 
-    // Juggle back override value
+    // Juggle back override value.
     if ( ! empty( $override ) ) {
         $retval['override'] = $override;
@@ -369 +365 @@
  * @since 1.9.0
  *
- * @param int         $friendship_id
- * @param int         $initiator_user_id
- * @param int         $friend_user_id
- * @param object|bool $friendship Optional
+ * @param int         $friendship_id       ID of the friendship.
+ * @param int         $initiator_user_id   ID of friendship initiator.
+ * @param int         $friend_user_id      ID of user whose friendship is requested.
+ * @param object|bool $friendship Optional Friendship object.
  */
 function bp_friends_friendship_accepted_activity( $friendship_id, $initiator_user_id, $friend_user_id, $friendship = false ) {
@@ -379 +375 @@
     }
 
-    // Record in activity streams for the initiator
+    // Record in activity streams for the initiator.
     friends_record_activity( array(
         'user_id'           => $initiator_user_id,