Changeset 10303 for trunk/src/bp-notifications/bp-notifications-loader.php

Timestamp:

10/22/2015 06:02:55 AM (11 years ago)

Author:

tw2113

Message:

More docs cleanup for Notifications component.

See #6404.

File:

• trunk/src/bp-notifications/bp-notifications-loader.php (modified) (12 diffs)

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

@@ -13 +13 @@
 defined( 'ABSPATH' ) || exit;
 
+/**
+ * Extends the component class to set up the Notifications component.
+ */
 class BP_Notifications_Component extends BP_Component {
 
@@ -66 +69 @@
                 $bp = buddypress();
 
-                // Define a slug, if necessary
+                // Define a slug, if necessary.
                 if ( ! defined( 'BP_NOTIFICATIONS_SLUG' ) ) {
                         define( 'BP_NOTIFICATIONS_SLUG', $this->id );
                 }
 
-                // Global tables for the notifications component
+                // Global tables for the notifications component.
                 $global_tables = array(
                         'table_name'      => $bp->table_prefix . 'bp_notifications',
@@ -103 +106 @@
         public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
 
-                // Determine user to use
+                // Determine user to use.
                 if ( bp_displayed_user_domain() ) {
                         $user_domain = bp_displayed_user_domain();
@@ -116 +119 @@
                 $notifications_link = trailingslashit( $user_domain . $slug );
 
-                // Only grab count if we're on a user page and current user has access
+                // Only grab count if we're on a user page and current user has access.
                 if ( bp_is_user() && bp_user_has_access() ) {
                         $count    = bp_notifications_get_unread_notification_count( bp_displayed_user_id() );
@@ -125 +128 @@
                 }
 
-                // Add 'Notifications' to the main navigation
+                // Add 'Notifications' to the main navigation.
                 $main_nav = array(
                         'name'                    => $nav_name,
@@ -136 +139 @@
                 );
 
-                // Add the subnav items to the notifications nav item
+                // Add the subnav items to the notifications nav item.
                 $sub_nav[] = array(
                         'name'            => _x( 'Unread', 'Notification screen nav', 'buddypress' ),
@@ -174 +177 @@
         public function setup_admin_bar( $wp_admin_nav = array() ) {
 
-                // Menus for logged in user
+                // Menus for logged in user.
                 if ( is_user_logged_in() ) {
 
-                        // Setup the logged in user variables
+                        // Setup the logged in user variables.
                         $notifications_link = trailingslashit( bp_loggedin_user_domain() . bp_get_notifications_slug() );
 
-                        // Pending notification requests
+                        // Pending notification requests.
                         $count = bp_notifications_get_unread_notification_count( bp_loggedin_user_id() );
                         if ( ! empty( $count ) ) {
@@ -190 +193 @@
                         }
 
-                        // Add the "My Account" sub menus
+                        // Add the "My Account" sub menus.
                         $wp_admin_nav[] = array(
                                 'parent' => buddypress()->my_account_menu_id,
@@ -198 +201 @@
                         );
 
-                        // Unread
+                        // Unread.
                         $wp_admin_nav[] = array(
                                 'parent' => 'my-account-' . $this->id,
@@ -206 +209 @@
                         );
 
-                        // Read
+                        // Read.
                         $wp_admin_nav[] = array(
                                 'parent' => 'my-account-' . $this->id,
@@ -225 +228 @@
         public function setup_title() {
 
-                // Adjust title
+                // Adjust title.
                 if ( bp_is_notifications_component() ) {
                         $bp = buddypress();
@@ -251 +254 @@
         public function setup_cache_groups() {
 
-                // Global groups
+                // Global groups.
                 wp_cache_add_global_groups( array(
                         'bp_notifications',