WordPress.org
Get WordPress

Make WordPress Core


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/tests/phpunit/tests/ajax/Compression.php

    r46586 r47122  
    22
    33/**
    4  * Admin ajax functions to be tested
     4 * Admin Ajax functions to be tested.
    55 */
    66require_once( ABSPATH . 'wp-admin/includes/ajax-actions.php' );
    77
    88/**
    9  * Testing ajax compression test functionality
     9 * Testing Ajax compression test functionality.
    1010 *
    1111 * @package    WordPress
    … …  
    2222        $this->logout();
    2323
    24         // Set up a default request
     24        // Set up a default request.
    2525        $_GET['test'] = 1;
    2626
    27         // Make the request
     27        // Make the request.
    2828        $this->setExpectedException( 'WPAjaxDieStopException', '-1' );
    2929        $this->_handleAjax( 'wp-compression-test' );
    … …  
    3535    public function test_text() {
    3636
    37         // Become an administrator
    38         $this->_setRole( 'administrator' );
    39 
    40         // Set up a default request
     37        // Become an administrator.
     38        $this->_setRole( 'administrator' );
     39
     40        // Set up a default request.
    4141        $_GET['test'] = 1;
    4242
    43         // Make the request
     43        // Make the request.
    4444        try {
    4545            $this->_handleAjax( 'wp-compression-test' );
    … …  
    4848        }
    4949
    50         // Ensure we found the right match
     50        // Ensure we found the right match.
    5151        $this->assertContains( 'wpCompressionTest', $this->_last_response );
    5252    }
    … …  
    6161        }
    6262
    63         // Become an administrator
    64         $this->_setRole( 'administrator' );
    65 
    66         // Set up a default request
     63        // Become an administrator.
     64        $this->_setRole( 'administrator' );
     65
     66        // Set up a default request.
    6767        $_GET['test']                    = 2;
    6868        $_SERVER['HTTP_ACCEPT_ENCODING'] = 'deflate';
    6969
    70         // Make the request
     70        // Make the request.
    7171        try {
    7272            $this->_handleAjax( 'wp-compression-test' );
    … …  
    7575        }
    7676
    77         // Ensure we found the right match
     77        // Ensure we found the right match.
    7878        $this->assertContains( 'wpCompressionTest', gzinflate( $this->_last_response ) );
    7979    }
    … …  
    8888        }
    8989
    90         // Become an administrator
    91         $this->_setRole( 'administrator' );
    92 
    93         // Set up a default request
     90        // Become an administrator.
     91        $this->_setRole( 'administrator' );
     92
     93        // Set up a default request.
    9494        $_GET['test']                    = 2;
    9595        $_SERVER['HTTP_ACCEPT_ENCODING'] = 'gzip';
    9696
    97         // Make the request
     97        // Make the request.
    9898        try {
    9999            $this->_handleAjax( 'wp-compression-test' );
    … …  
    102102        }
    103103
    104         // Ensure we found the right match
     104        // Ensure we found the right match.
    105105        $this->assertContains( 'wpCompressionTest', $this->_gzdecode( $this->_last_response ) );
    106106    }
    … …  
    111111    public function test_unknown_encoding() {
    112112
    113         // Become an administrator
    114         $this->_setRole( 'administrator' );
    115 
    116         // Set up a default request
     113        // Become an administrator.
     114        $this->_setRole( 'administrator' );
     115
     116        // Set up a default request.
    117117        $_GET['test']                    = 2;
    118118        $_SERVER['HTTP_ACCEPT_ENCODING'] = 'unknown';
    119119
    120         // Make the request
     120        // Make the request.
    121121        $this->setExpectedException( 'WPAjaxDieStopException', '-1' );
    122122        $this->_handleAjax( 'wp-compression-test' );
    … …  
    128128    public function test_set_yes() {
    129129
    130         // Become an administrator
    131         $this->_setRole( 'administrator' );
    132 
    133         // Set up a default request
     130        // Become an administrator.
     131        $this->_setRole( 'administrator' );
     132
     133        // Set up a default request.
    134134        $_GET['test'] = 'yes';
    135135
    136         // Set the option to false
     136        // Set the option to false.
    137137        update_site_option( 'can_compress_scripts', 0 );
    138138
    139         // Make the request
    140         try {
    141             $this->_handleAjax( 'wp-compression-test' );
    142         } catch ( WPAjaxDieStopException $e ) {
    143             unset( $e );
    144         }
    145 
    146         // Check the site option is not changed due to lack of nonce
     139        // Make the request.
     140        try {
     141            $this->_handleAjax( 'wp-compression-test' );
     142        } catch ( WPAjaxDieStopException $e ) {
     143            unset( $e );
     144        }
     145
     146        // Check the site option is not changed due to lack of nonce.
    147147        $this->assertEquals( 0, get_site_option( 'can_compress_scripts' ) );
    148148
    149         // Add a nonce
     149        // Add a nonce.
    150150        $_GET['_ajax_nonce'] = wp_create_nonce( 'update_can_compress_scripts' );
    151151
    152         // Retry the request
    153         try {
    154             $this->_handleAjax( 'wp-compression-test' );
    155         } catch ( WPAjaxDieStopException $e ) {
    156             unset( $e );
    157         }
    158 
    159         // Check the site option is changed
     152        // Retry the request.
     153        try {
     154            $this->_handleAjax( 'wp-compression-test' );
     155        } catch ( WPAjaxDieStopException $e ) {
     156            unset( $e );
     157        }
     158
     159        // Check the site option is changed.
    160160        $this->assertEquals( 1, get_site_option( 'can_compress_scripts' ) );
    161161    }
    … …  
    166166    public function test_set_no() {
    167167
    168         // Become an administrator
    169         $this->_setRole( 'administrator' );
    170 
    171         // Set up a default request
     168        // Become an administrator.
     169        $this->_setRole( 'administrator' );
     170
     171        // Set up a default request.
    172172        $_GET['test'] = 'no';
    173173
    174         // Set the option to true
     174        // Set the option to true.
    175175        update_site_option( 'can_compress_scripts', 1 );
    176176
    177         // Make the request
    178         try {
    179             $this->_handleAjax( 'wp-compression-test' );
    180         } catch ( WPAjaxDieStopException $e ) {
    181             unset( $e );
    182         }
    183 
    184         // Check the site option is not changed due to lack of nonce
     177        // Make the request.
     178        try {
     179            $this->_handleAjax( 'wp-compression-test' );
     180        } catch ( WPAjaxDieStopException $e ) {
     181            unset( $e );
     182        }
     183
     184        // Check the site option is not changed due to lack of nonce.
    185185        $this->assertEquals( 1, get_site_option( 'can_compress_scripts' ) );
    186186
    187         // Add a nonce
     187        // Add a nonce.
    188188        $_GET['_ajax_nonce'] = wp_create_nonce( 'update_can_compress_scripts' );
    189189
    190         // Retry the request
    191         try {
    192             $this->_handleAjax( 'wp-compression-test' );
    193         } catch ( WPAjaxDieStopException $e ) {
    194             unset( $e );
    195         }
    196 
    197         // Check the site option is changed
     190        // Retry the request.
     191        try {
     192            $this->_handleAjax( 'wp-compression-test' );
     193        } catch ( WPAjaxDieStopException $e ) {
     194            unset( $e );
     195        }
     196
     197        // Check the site option is changed.
    198198        $this->assertEquals( 0, get_site_option( 'can_compress_scripts' ) );
    199199    }
    … …  
    207207    protected function _gzdecode( $encoded_data ) {
    208208
    209         // Save the encoded data to a temp file
     209        // Save the encoded data to a temp file.
    210210        $file = wp_tempnam( 'gzdecode' );
    211211        file_put_contents( $file, $encoded_data );
    212212
    213         // Flush it to the output buffer and delete the temp file
     213        // Flush it to the output buffer and delete the temp file.
    214214        ob_start();
    215215        readgzfile( $file );
    216216        unlink( $file );
    217217
    218         // Save the data stop buffering
     218        // Save the data stop buffering.
    219219        $data = ob_get_clean();
    220220
    221         // Done
     221        // Done.
    222222        return $data;
    223223    }
Note: See TracChangeset for help on using the changeset viewer.