Changeset 47122 for trunk/tests/phpunit/tests/xmlrpc/wp/getTerms.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/getTerms.php (modified) (9 diffs)

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

@@ -42 +42 @@
                 $this->make_user_by_role( 'editor' );
 
-                // make sure there's at least one category
+                // Make sure there's at least one category.
                 $cat = wp_insert_term( 'term_' . __FUNCTION__, 'category' );
 
@@ -51 +51 @@
                         $this->assertInternalType( 'int', $term['count'] );
 
-                        // Check custom term meta
+                        // Check custom term meta.
                         $this->assertInternalType( 'array', $term['custom_fields'] );
 
-                        // We expect all other IDs to be strings not integers so we don't return something larger than an XMLRPC integer can describe.
+                        // We expect all other IDs to be strings, not integers,
+                        // so we don't return something larger than an XMLRPC integer can describe.
                         $this->assertStringMatchesFormat( '%d', $term['term_id'] );
                         $this->assertStringMatchesFormat( '%d', $term['term_group'] );
@@ -65 +66 @@
                 $this->make_user_by_role( 'editor' );
 
-                // create a taxonomy and some terms for it
+                // Create a taxonomy and some terms for it.
                 $tax_name  = 'wp_getTerms_custom_taxonomy';
                 $num_terms = 12;
@@ -73 +74 @@
                 }
 
-                // test fetching all terms
+                // Test fetching all terms.
                 $results = $this->myxmlrpcserver->wp_getTerms( array( 1, 'editor', 'editor', $tax_name ) );
                 $this->assertNotIXRError( $results );
@@ -82 +83 @@
                 }
 
-                // test paged results
+                // Test paged results.
                 $filter   = array( 'number' => 5 );
                 $results2 = $this->myxmlrpcserver->wp_getTerms( array( 1, 'editor', 'editor', $tax_name, $filter ) );
                 $this->assertNotIXRError( $results );
                 $this->assertEquals( 5, count( $results2 ) );
-                $this->assertEquals( $results[1]['term_id'], $results2[1]['term_id'] ); // check one of the terms
+                $this->assertEquals( $results[1]['term_id'], $results2[1]['term_id'] ); // Check one of the terms.
 
                 $filter['offset'] = 10;
@@ -95 +96 @@
                 $this->assertEquals( $results[11]['term_id'], $results3[1]['term_id'] );
 
-                // test hide_empty (since none have been attached to posts yet, all should be hidden
+                // Test hide_empty (since none have been attached to posts yet, all should be hidden.
                 $filter   = array( 'hide_empty' => true );
                 $results4 = $this->myxmlrpcserver->wp_getTerms( array( 1, 'editor', 'editor', $tax_name, $filter ) );
@@ -123 +124 @@
                 foreach ( $results as $term ) {
                         if ( $term['term_id'] === $cat1 ) {
-                                break;  // found cat1 first as expected
+                                break; // Found cat1 first as expected.
                         } elseif ( $term['term_id'] === $cat2 ) {
                                 $this->assertFalse( false, 'Incorrect category ordering.' );
@@ -136 +137 @@
                 $name_id = wp_create_category( $name );
 
-                // search by full name
+                // Search by full name.
                 $filter  = array( 'search' => $name );
                 $results = $this->myxmlrpcserver->wp_getTerms( array( 1, 'editor', 'editor', 'category', $filter ) );
@@ -144 +145 @@
                 $this->assertEquals( $name_id, $results[0]['term_id'] );
 
-                // search by partial name
+                // Search by partial name.
                 $filter   = array( 'search' => substr( $name, 0, 10 ) );
                 $results2 = $this->myxmlrpcserver->wp_getTerms( array( 1, 'editor', 'editor', 'category', $filter ) );