Changeset 10253 for trunk/src/bp-activity/bp-activity-notifications.php

Timestamp:

10/12/2015 05:45:14 AM (9 years ago)

Author:

tw2113

Message:

Further documentation cleanup for Activity Component.

See #6396.

File:

• trunk/src/bp-activity/bp-activity-notifications.php (modified) (18 diffs)

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

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -41 +41 @@
 function bp_activity_at_message_notification( $activity_id, $receiver_user_id ) {
 
-    // Don't leave multiple notifications for the same activity item
+    // Don't leave multiple notifications for the same activity item.
     $notifications = BP_Core_Notification::get_all_for_user( $receiver_user_id, 'all' );
 
@@ -56 +56 @@
     $content = '';
 
-    // Now email the user with the contents of the message (if they have enabled email notifications)
+    // Now email the user with the contents of the message (if they have enabled email notifications).
     if ( 'no' != bp_get_user_meta( $receiver_user_id, 'notification_activity_new_mention', true ) ) {
         $poster_name = bp_core_get_user_displayname( $activity->user_id );
@@ -67 +67 @@
         $content = bp_activity_filter_kses( strip_tags( stripslashes( $activity->content ) ) );
 
-        // Set up and send the message
+        // Set up and send the message.
         $ud       = bp_core_get_core_userdata( $receiver_user_id );
         $to       = $ud->user_email;
@@ -94 +94 @@
         }
 
-        // Only show the disable notifications line if the settings component is enabled
+        // Only show the disable notifications line if the settings component is enabled.
         if ( bp_is_active( 'settings' ) ) {
             $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
@@ -175 +175 @@
  * @param int   $comment_id   The comment id.
  * @param int   $commenter_id The ID of the user who posted the comment.
- * @param array $params       {@link bp_activity_new_comment()}
- *
+ * @param array $params       {@link bp_activity_new_comment()}.
  * @return bool
  */
 function bp_activity_new_comment_notification( $comment_id = 0, $commenter_id = 0, $params = array() ) {
 
-    // Set some default parameters
+    // Set some default parameters.
     $activity_id = 0;
     $parent_id   = 0;
@@ -198 +197 @@
         $content = bp_activity_filter_kses( stripslashes($content) );
 
-        // Set up and send the message
+        // Set up and send the message.
         $ud      = bp_core_get_core_userdata( $original_activity->user_id );
         $to      = $ud->user_email;
@@ -212 +211 @@
 ', 'buddypress' ), $poster_name, $content, $thread_link );
 
-        // Only show the disable notifications line if the settings component is enabled
+        // Only show the disable notifications line if the settings component is enabled.
         if ( bp_is_active( 'settings' ) ) {
             $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
@@ -266 +265 @@
     }
 
-    /***
+    /*
      * If this is a reply to another comment, send an email notification to the
      * author of the immediate parent comment.
@@ -282 +281 @@
         $settings_link = bp_core_get_user_domain( $parent_comment->user_id ) . $settings_slug . '/notifications/';
 
-        // Set up and send the message
+        // Set up and send the message.
         $ud       = bp_core_get_core_userdata( $parent_comment->user_id );
         $to       = $ud->user_email;
@@ -300 +299 @@
 ', 'buddypress' ), $poster_name, $content, $thread_link );
 
-        // Only show the disable notifications line if the settings component is enabled
+        // Only show the disable notifications line if the settings component is enabled.
         if ( bp_is_active( 'settings' ) ) {
             $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
@@ -360 +359 @@
  * @since 1.9.0
  *
- * @param int   $comment_id
- * @param array $params
+ * @param int   $comment_id ID of the comment being notified about.
+ * @param array $params     Parameters to use with notification.
  */
 function bp_activity_new_comment_notification_helper( $comment_id, $params ) {
@@ -387 +386 @@
  * @param int    $total_items       The total number of notifications to format.
  * @param string $format            'string' to get a BuddyBar-compatible notification, 'array' otherwise.
- *
  * @return string $return Formatted @mention notification.
  */
@@ -476 +474 @@
  * @since 1.9.0
  *
- * @param object $activity
- * @param string $subject (not used)
- * @param string $message (not used)
- * @param string $content (not used)
- * @param int    $receiver_user_id
+ * @param object $activity           Activity object.
+ * @param string $subject (not used) Notification subject.
+ * @param string $message (not used) Notification message.
+ * @param string $content (not used) Notification content.
+ * @param int    $receiver_user_id   ID of user receiving notification.
  */
 function bp_activity_at_mention_add_notification( $activity, $subject, $message, $content, $receiver_user_id ) {
@@ -509 +507 @@
     }
 
-    // Only mark read if you're looking at your own mentions
+    // Only mark read if you're looking at your own mentions.
     if ( ! bp_is_my_profile() ) {
         return;
@@ -523 +521 @@
  * @since 2.0.0
  *
- * @param object BP_Activity_Activity
+ * @param BP_Activity_Activity $activity Activity object.
  */
 function bp_activity_remove_screen_notifications_single_activity_permalink( $activity ) {
@@ -534 +532 @@
     }
 
-    // Mark as read any notifications for the current user related to this
-    // activity item
+    // Mark as read any notifications for the current user related to this activity item.
     bp_notifications_mark_notifications_by_item_id( bp_loggedin_user_id(), $activity->id, buddypress()->activity->id, 'new_at_mention' );
 }
@@ -549 +546 @@
 function bp_activity_at_mention_delete_notification( $activity_ids_deleted = array() ) {
     // Let's delete all without checking if content contains any mentions
-    // to avoid a query to get the activity
+    // to avoid a query to get the activity.
     if ( bp_is_active( 'notifications' ) && ! empty( $activity_ids_deleted ) ) {
         foreach ( $activity_ids_deleted as $activity_id ) {