Changeset 47122 for trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

Timestamp:

01/29/2020 12:43:23 AM (5 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/rest-api/rest-posts-controller.php (modified) (17 diffs)

trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -62 +62 @@
         }
 
-        // Only support 'post' and 'gallery'
+        // Only support 'post' and 'gallery'.
         self::$supported_formats = get_theme_support( 'post-formats' );
         add_theme_support( 'post-formats', array( 'post', 'gallery' ) );
@@ -151 +151 @@
 
     public function test_context_param() {
-        // Collection
+        // Collection.
         $request  = new WP_REST_Request( 'OPTIONS', '/wp/v2/posts' );
         $response = rest_get_server()->dispatch( $request );
@@ -157 +157 @@
         $this->assertEquals( 'view', $data['endpoints'][0]['args']['context']['default'] );
         $this->assertEquals( array( 'view', 'embed', 'edit' ), $data['endpoints'][0]['args']['context']['enum'] );
-        // Single
+        // Single.
         $request  = new WP_REST_Request( 'OPTIONS', '/wp/v2/posts/' . self::$post_id );
         $response = rest_get_server()->dispatch( $request );
@@ -1455 +1455 @@
      */
     public function test_get_items_invalid_max_pages() {
-        // Out of bounds
+        // Out of bounds.
         $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
         $request->set_param( 'page', REST_TESTS_IMPOSSIBLY_HIGH_NUMBER );
@@ -2051 +2051 @@
         add_filter( 'theme_post_templates', array( $this, 'filter_theme_post_templates' ) );
 
-        // reregister the route as we now have a template available.
+        // Re-register the route as we now have a template available.
         $GLOBALS['wp_rest_server']->override_by_default = true;
         $controller                                     = new WP_REST_Posts_Controller( 'post' );
@@ -2153 +2153 @@
         $params  = $this->set_post_data(
             array(
-                // This results in a special `post_date_gmt` value of
-                // '0000-00-00 00:00:00'.  See #38883.
+                // This results in a special `post_date_gmt` value
+                // of '0000-00-00 00:00:00'. See #38883.
                 'status' => 'pending',
             )
@@ -2253 +2253 @@
         $this->assertEquals( 'draft', $data['status'] );
         $this->assertEquals( 'draft', $new_post->post_status );
-        // Confirm dates are shimmed for gmt_offset
+        // Confirm dates are shimmed for gmt_offset.
         $post_modified_gmt = gmdate( 'Y-m-d H:i:s', strtotime( $new_post->post_modified ) + ( get_option( 'gmt_offset' ) * 3600 ) );
         $post_date_gmt     = gmdate( 'Y-m-d H:i:s', strtotime( $new_post->post_date ) + ( get_option( 'gmt_offset' ) * 3600 ) );
@@ -2776 +2776 @@
         $request->set_param( 'author', $post->post_author );
 
-        // Run twice to make sure that the update still succeeds even if no DB
-        // rows are updated.
+        // Run twice to make sure that the update still succeeds
+        // even if no DB rows are updated.
         $response = rest_get_server()->dispatch( $request );
         $this->check_update_post_response( $response );
@@ -3225 +3225 @@
         $this->assertEquals( true, is_sticky( $post->ID ) );
 
-        // Updating another field shouldn't change sticky status
+        // Updating another field shouldn't change sticky status.
         $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
         $params  = $this->set_post_data(
@@ -3565 +3565 @@
 
     public function verify_post_roundtrip( $input = array(), $expected_output = array() ) {
-        // Create the post
+        // Create the post.
         $request = new WP_REST_Request( 'POST', '/wp/v2/posts' );
         foreach ( $input as $name => $value ) {
@@ -3574 +3574 @@
         $actual_output = $response->get_data();
 
-        // Compare expected API output to actual API output
+        // Compare expected API output to actual API output.
         $this->assertEquals( $expected_output['title']['raw'], $actual_output['title']['raw'] );
         $this->assertEquals( $expected_output['title']['rendered'], trim( $actual_output['title']['rendered'] ) );
@@ -3582 +3582 @@
         $this->assertEquals( $expected_output['excerpt']['rendered'], trim( $actual_output['excerpt']['rendered'] ) );
 
-        // Compare expected API output to WP internal values
+        // Compare expected API output to WP internal values.
         $post = get_post( $actual_output['id'] );
         $this->assertEquals( $expected_output['title']['raw'], $post->post_title );
@@ -3588 +3588 @@
         $this->assertEquals( $expected_output['excerpt']['raw'], $post->post_excerpt );
 
-        // Update the post
+        // Update the post.
         $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/posts/%d', $actual_output['id'] ) );
         foreach ( $input as $name => $value ) {
@@ -3597 +3597 @@
         $actual_output = $response->get_data();
 
-        // Compare expected API output to actual API output
+        // Compare expected API output to actual API output.
         $this->assertEquals( $expected_output['title']['raw'], $actual_output['title']['raw'] );
         $this->assertEquals( $expected_output['title']['rendered'], trim( $actual_output['title']['rendered'] ) );
@@ -3605 +3605 @@
         $this->assertEquals( $expected_output['excerpt']['rendered'], trim( $actual_output['excerpt']['rendered'] ) );
 
-        // Compare expected API output to WP internal values
+        // Compare expected API output to WP internal values.
         $post = get_post( $actual_output['id'] );
         $this->assertEquals( $expected_output['title']['raw'], $post->post_title );
@@ -3928 +3928 @@
         register_taxonomy( 'status', 'post', array( 'show_in_rest' => true ) );
 
-        // Re-initialize the controller
+        // Re-initialize the controller.
         $controller = new WP_REST_Posts_Controller( 'post' );
         $controller->register_routes();
@@ -4539 +4539 @@
         $response = rest_do_request( $request );
         $links    = $response->get_links();
-        // Authors can't ever unfiltered html
+        // Authors can't ever unfiltered html.
         $this->assertArrayNotHasKey( 'https://api.w.org/action-unfiltered-html', $links );
     }