Changeset 13091 for trunk/src/bp-notifications/classes/class-bp-notifications-template.php

Timestamp:

08/23/2021 02:03:02 AM (4 years ago)

Author:

espellcaste

Message:

Making PHPDoc Improvements to the BP Notifications (component) files.

See #8553

File:

• trunk/src/bp-notifications/classes/class-bp-notifications-template.php (modified) (8 diffs)

trunk/src/bp-notifications/classes/class-bp-notifications-template.php

@@ -142 +142 @@
     /**
      * Constructor method.
-     *
-     * @see bp_has_notifications() For information on the array format.
      *
      * @since 1.9.0
@@ -171 +169 @@
             'max'               => null,
             'meta_query'        => false,
-            'date_query'        => false
+            'date_query'        => false,
         ) );
 
         // Sort order direction.
         $orders = array( 'ASC', 'DESC' );
-        if ( ! empty( $_GET['sort_order'] ) && in_array( $_GET['sort_order'], $orders ) ) {
+        if ( ! empty( $_GET['sort_order'] ) && in_array( $_GET['sort_order'], $orders, true ) ) {
             $r['sort_order'] = $_GET['sort_order'];
         } else {
@@ -184 +182 @@
         // Setup variables.
         $this->pag_arg      = sanitize_key( $r['page_arg'] );
-        $this->pag_page     = bp_sanitize_pagination_arg( $this->pag_arg, $r['page']     );
-        $this->pag_num      = bp_sanitize_pagination_arg( 'num',          $r['per_page'] );
+        $this->pag_page     = bp_sanitize_pagination_arg( $this->pag_arg, $r['page'] );
+        $this->pag_num      = bp_sanitize_pagination_arg( 'num', $r['per_page'] );
         $this->user_id      = $r['user_id'];
         $this->is_new       = $r['is_new'];
@@ -239 +237 @@
                 'current'   => $this->pag_page,
                 'prev_text' => _x( '←', 'Notifications pagination previous text', 'buddypress' ),
-                'next_text' => _x( '→', 'Notifications pagination next text',     'buddypress' ),
+                'next_text' => _x( '→', 'Notifications pagination next text', 'buddypress' ),
                 'mid_size'  => 1,
                 'add_args'  => $add_args,
@@ -256 +254 @@
      */
     public function has_notifications() {
-        if ( $this->notification_count ) {
-            return true;
-        }
-
-        return false;
+        return ! empty( $this->notification_count );
     }
 
@@ -268 +262 @@
      * @since 1.9.0
      *
-     * @return object The next notification to iterate over.
+     * @return BP_Notifications_Notification The next notification to iterate over.
      */
     public function next_notification() {
@@ -312 +306 @@
             return true;
 
-        } elseif ( $this->current_notification + 1 == $this->notification_count ) {
+        } elseif ( $this->current_notification + 1 === $this->notification_count ) {
 
             /**
@@ -319 +313 @@
              * @since 1.9.0
              */
-            do_action( 'notifications_loop_end');
+            do_action( 'notifications_loop_end' );
 
             $this->rewind_notifications();