Changeset 11842

Timestamp:

05/13/2022 04:45:59 PM (2 years ago)

Author:

iandunn

Message:

Profiles: Apply coding standards.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-profiles-wp-activity-notifier/wporg-profiles-wp-activity-notifier.php (modified) (21 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-profiles-wp-activity-notifier/wporg-profiles-wp-activity-notifier.php

@@ -8 +8 @@
 
 class WPOrg_WP_Activity_Notifier {
-
     private $activity_handler_url = 'https://profiles.wordpress.org/wp-admin/admin-ajax.php';
 
@@ -19 +18 @@
      * Returns always the same instance of this plugin.
      *
-     * @return Plugin
+     * @return WPOrg_WP_Activity_Notifier
      */
     public static function get_instance() {
@@ -25 +24 @@
             self::$instance = new self();
         }
+
         return self::$instance;
     }
@@ -62 +62 @@
      *
      * @param WP_Post $post The post
+     *
      * @return boolean True == the post can be notified about.
      */
     public function is_post_notifiable( $post ) {
-
         // Sanity check the argument is a post
-        if ( ! $post || ! is_a( $post, 'WP_Post' ) )
+        if ( ! $post || ! is_a( $post, 'WP_Post' ) ) {
             return false;
+        }
 
         // Don't notify if the site is for subscribers only
-        if ( class_exists( 'Subscribers_Only' ) )
+        if ( class_exists( 'Subscribers_Only' ) ) {
             $notifiable = false;
+        }
 
         // Don't notify if not of 'post' post_type
-        elseif ( 'post' != $post->post_type )
+        elseif ( 'post' != $post->post_type ) {
             $notifiable = false;
+        }
 
         // Don't notify if not publicly published
-        elseif ( 'publish' != $post->post_status )
+        elseif ( 'publish' != $post->post_status ) {
             $notifiable = false;
+        }
 
         // Don't notify if password is required
-        elseif ( ! empty( $post->post_password ) )
+        elseif ( ! empty( $post->post_password ) ) {
             $notifiable = false;
+        }
 
         // At this point it is permitted to notify about the post
-        else
+        else {
             $notifiable = true;
+        }
 
         // Return filtered value to allow overriding or extending checks
         return apply_filters( 'wporg_profiles_wp_activity-is_post_notifiable', $notifiable, $post );
-
     }
 
@@ -98 +103 @@
      * Only send notification for post getting published.
      *
-     * @param string $new_status The new status for the post
-     * @param string $old_status The old status for the post
+     * @param string  $new_status The new status for the post
+     * @param string  $old_status The old status for the post
      * @param WP_Post $post The post
      */
     public function maybe_notify_new_published_post( $new_status, $old_status, $post ) {
-
         // Only proceed if the post is transitioning to the publish status
-        if ( 'publish' != $new_status )
-            return;
+        if ( 'publish' != $new_status ) {
+            return;
+        }
 
         // Only proceed if the post is actually changing status
-        if ( $old_status == $new_status )
-            return;
+        if ( $old_status == $new_status ) {
+            return;
+        }
 
         // Only proceed if permitted to notify about the post
-        if ( ! $this->is_post_notifiable( $post ) )
-            return;
+        if ( ! $this->is_post_notifiable( $post ) ) {
+            return;
+        }
 
         // Send notification for the post
@@ -149 +156 @@
                 'content'  => $content,
                 'url'      => get_permalink( $post->ID ),
-            )
+            ),
         );
 
@@ -158 +165 @@
      * Handler for comment creation.
      *
-     * @param int $id         Comment ID
-     * @param object $comment Comment
-     * @return void
-    */
+     * @param int        $id      Comment ID
+     * @param WP_Comment $comment Comment
+     */
     function insert_comment( $id, $comment ) {
-        if ( 1 == $comment->comment_approved )
+        if ( 1 == $comment->comment_approved ) {
             $this->maybe_notify_new_approved_comment( 'approved', '', $comment );
+        }
     }
 
@@ -170 +177 @@
      * Only send notification for comment getting published on a public post.
      *
-     * @param string $new_status The new status for the comment
-     * @param string $old_status The old status for the comment
+     * @param string     $new_status The new status for the comment
+     * @param string     $old_status The old status for the comment
+     * @param WP_Comment $comment    The comment
+     */
+    public function maybe_notify_new_approved_comment( $new_status, $old_status, $comment ) {
+        // Only proceed if the comment is transitioning to the approved status
+        if ( 'approved' != $new_status ) {
+            return;
+        }
+
+        $post = get_post( $comment->comment_post_ID );
+
+        // Only proceed if permitted to notify about the post
+        if ( ! $this->is_post_notifiable( $post ) ) {
+            return;
+        }
+
+        // Only proceed if there are no objections to the comment notification
+        if ( apply_filters( 'wporg_profiles_wp_activity-is_comment_notifiable', true, $comment, $post ) ) {
+            $this->notify_new_approved_comment( $comment, $post );
+        }
+    }
+
+    /**
+     * Sends activity notification for new comment.
+     *
      * @param WP_Comment $comment The comment
-     */
-    public function maybe_notify_new_approved_comment( $new_status, $old_status, $comment ) {
-
-        // Only proceed if the comment is transitioning to the approved status
-        if ( 'approved' != $new_status )
-            return;
-
-        $post = get_post( $comment->comment_post_ID );
-
-        // Only proceed if permitted to notify about the post
-        if ( ! $this->is_post_notifiable( $post ) )
-            return;
-
-        // Only proceed if there are no objections to the comment notification
-        if ( apply_filters( 'wporg_profiles_wp_activity-is_comment_notifiable', true, $comment, $post ) )
-            $this->notify_new_approved_comment( $comment, $post );
-    }
-
-    /**
-     * Sends activity notification for new comment.
-     *
-     * @param WP_Comment $comment The comment
-     * @param WP_Post $post The comment's post
+     * @param WP_Post    $post The comment's post
      */
     private function notify_new_approved_comment( $comment, $post ) {
@@ -203 +212 @@
         }
 
-        if ( ! $comment->user_id )
-            return;
-
-        if ( ! $user = get_user_by( 'id', $comment->user_id ) )
-            return;
+        if ( ! $comment->user_id ) {
+            return;
+        }
+
+        if ( ! $user = get_user_by( 'id', $comment->user_id ) ) {
+            return;
+        }
 
         $args = array(
@@ -220 +231 @@
                 'blog_url'   => site_url(),
                 'url'        => get_comment_link( $comment ),
-            )
+            ),
         );
 
@@ -235 +246 @@
      */
     private function _notify_forum_topic_payload( $activity, $topic_id ) {
-
         // Don't notify if importing.
         if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
@@ -258 +268 @@
         $url = bbp_get_topic_permalink( $topic_id );
         // Remove moderator flags
-        $url = remove_query_arg( [ 'view' ], $url );
+        $url = remove_query_arg( array( 'view' ), $url );
 
         $args = array(
@@ -274 +284 @@
                 'site'      => get_bloginfo( 'name' ),
                 'site_url'  => site_url(),
-            )
+            ),
         );
 
@@ -307 +317 @@
      */
     private function _notify_forum_reply_payload( $activity, $reply_id ) {
-
         // Don't notify if importing.
         if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
@@ -330 +339 @@
         $url = bbp_get_reply_url( $reply_id );
         // Remove moderator flags
-        $url = remove_query_arg( [ 'view' ], $url );
+        $url = remove_query_arg( array( 'view' ), $url );
 
         $args = array(
@@ -346 +355 @@
                 'site'      => get_bloginfo( 'name' ),
                 'site_url'  => site_url(),
-            )
+            ),
         );
 
         wp_remote_post( $this->activity_handler_url, $args );
-
     }
 
@@ -381 +389 @@
      * @param int $reply_id Optional. The reply id.
      * @param int $words    Optional. The number of words for the excerpt. Default 15.
+     *
      * @return string
      */
@@ -401 +410 @@
      * @param int    $length     Optional. The number of words or characters to try down to. Default 15.
      * @param string $trim_style Optional. The manner in which the text should be trimmed. Either 'chars' or 'words'. Default 'words'.
+     *
      * @return string
      */
@@ -419 +429 @@
 
         // If trimming by chars, behave like a more multibyte-aware
-        // bbp_get_reply_excerp().
+        // /* bbp_get_reply_excerpt */().
         if ( 'chars' === $trim_style ) {
             // Multibyte support
@@ -437 +447 @@
             }
         }
+
         // Else trim by words.
         else {
@@ -444 +455 @@
         return $text;
     }
-
 }