Changeset 47122 for trunk/tests/phpunit/tests/xmlrpc/wp/getPosts.php

Timestamp:

01/29/2020 12:43:23 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/tests/phpunit/tests/xmlrpc/wp/getPosts.php (modified) (8 diffs)

trunk/tests/phpunit/tests/xmlrpc/wp/getPosts.php

@@ -65 +65 @@
                         );
                 }
-                // get them all
+                // Get them all.
                 $filter  = array(
                         'post_type' => $cpt_name,
@@ -74 +74 @@
                 $this->assertEquals( $num_posts, count( $results ) );
 
-                // page through results
+                // Page through results.
                 $posts_found      = array();
                 $filter['number'] = 2;
@@ -83 +83 @@
                         $filter['offset'] += $filter['number'];
                 } while ( count( $presults ) > 0 );
-                // verify that $post_ids matches $posts_found
+                // Verify that $post_ids matches $posts_found.
                 $this->assertEquals( 0, count( array_diff( $post_ids, $posts_found ) ) );
 
-                // add comments to some of the posts
+                // Add comments to some of the posts.
                 foreach ( $post_ids as $key => $post_id ) {
                         // Larger post IDs will get more comments.
@@ -92 +92 @@
                 }
 
-                // get results ordered by comment count
+                // Get results ordered by comment count.
                 $filter2  = array(
                         'post_type' => $cpt_name,
@@ -108 +108 @@
                 }
 
-                // set one of the posts to draft and get drafts
+                // Set one of the posts to draft and get drafts.
                 $post              = get_post( $post_ids[0] );
                 $post->post_status = 'draft';
@@ -128 +128 @@
                 self::factory()->post->create();
 
-                // check default fields
+                // Check default fields.
                 $results = $this->myxmlrpcserver->wp_getPosts( array( 1, 'editor', 'editor' ) );
                 $this->assertNotIXRError( $results );
-                $expected_fields = array( 'post_id', 'post_title', 'terms', 'custom_fields', 'link' ); // subset of expected fields
+                $expected_fields = array( 'post_id', 'post_title', 'terms', 'custom_fields', 'link' ); // Subset of expected fields.
                 foreach ( $expected_fields as $field ) {
                         $this->assertArrayHasKey( $field, $results[0] );
                 }
 
-                // request specific fields and verify that only those are returned
+                // Request specific fields and verify that only those are returned.
                 $filter   = array();
                 $fields   = array( 'post_name', 'post_author', 'enclosure' );
@@ -156 +156 @@
                 $post_ids[] = self::factory()->post->create( array( 'post_title' => 'Second: Hello, World!' ) );
 
-                // Search for none of them
+                // Search for none of them.
                 $filter  = array( 's' => 'Third' );
                 $results = $this->myxmlrpcserver->wp_getPosts( array( 1, 'editor', 'editor', $filter ) );
@@ -162 +162 @@
                 $this->assertEquals( 0, count( $results ) );
 
-                // Search for one of them
+                // Search for one of them.
                 $filter  = array( 's' => 'First:' );
                 $results = $this->myxmlrpcserver->wp_getPosts( array( 1, 'editor', 'editor', $filter ) );