Changeset 47122 for trunk/tests/phpunit/includes/utils.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/includes/utils.php (modified) (11 diffs)

trunk/tests/phpunit/includes/utils.php

@@ -1 +1 @@
 <?php
 
-// misc help functions and utilities
+// Misc help functions and utilities.
 
 function rand_str( $len = 32 ) {
@@ -19 +19 @@
 }
 
-// strip leading and trailing whitespace from each line in the string
+// Strip leading and trailing whitespace from each line in the string.
 function strip_ws( $txt ) {
         $lines  = explode( "\n", $txt );
@@ -32 +32 @@
 }
 
-// helper class for testing code that involves actions and filters
-// typical use:
-// $ma = new MockAction();
-// add_action('foo', array(&$ma, 'action'));
+/*
+ * Helper class for testing code that involves actions and filters.
+ * Typical use:
+ * $ma = new MockAction();
+ * add_action( 'foo', array( &$ma, 'action' ) );
+ */
 class MockAction {
         var $events;
@@ -130 +132 @@
 
         function filterall( $tag, ...$args ) {
-                // this one doesn't return the result, so it's safe to use with the new 'all' filter
+                // This one doesn't return the result, so it's safe to use with the new 'all' filter.
                 if ( $this->debug ) {
                         dmp( __FUNCTION__, $this->current_filter() );
@@ -142 +144 @@
         }
 
-        // return a list of all the actions, tags and args
+        // Return a list of all the actions, tags and args.
         function get_events() {
                 return $this->events;
         }
 
-        // return a count of the number of times the action was called since the last reset
+        // Return a count of the number of times the action was called since the last reset.
         function get_call_count( $tag = '' ) {
                 if ( $tag ) {
@@ -161 +163 @@
         }
 
-        // return an array of the tags that triggered calls to this action
+        // Return an array of the tags that triggered calls to this action.
         function get_tags() {
                 $out = array();
@@ -170 +172 @@
         }
 
-        // return an array of args passed in calls to this action
+        // Return an array of args passed in calls to this action.
         function get_args() {
                 $out = array();
@@ -180 +182 @@
 }
 
-// convert valid xml to an array tree structure
-// kinda lame but it works with a default php 4 installation
+// Convert valid XML to an array tree structure.
+// Kinda lame, but it works with a default PHP 4 installation.
 class TestXMLParser {
         var $xml;
@@ -313 +315 @@
 }
 
-// recursively generate some quick assertEquals tests based on an array
+// Recursively generate some quick assertEquals() tests based on an array.
 function gen_tests_array( $name, $array ) {
         $out = array();
@@ -368 +370 @@
 }
 
-// mask out any input fields matching the given name
+// Mask out any input fields matching the given name.
 function mask_input_value( $in, $name = '_wpnonce' ) {
         return preg_replace( '@<input([^>]*) name="' . preg_quote( $name ) . '"([^>]*) value="[^>]*" />@', '<input$1 name="' . preg_quote( $name ) . '"$2 value="***" />', $in );
@@ -396 +398 @@
 
 function _cleanup_query_vars() {
-        // clean out globals to stop them polluting wp and wp_query
+        // Clean out globals to stop them polluting wp and wp_query.
         foreach ( $GLOBALS['wp']->public_query_vars as $v ) {
                 unset( $GLOBALS[ $v ] );