Changeset 47041

Timestamp:

01/05/2020 03:31:10 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for tests/phpunit/includes/testcase-ajax.php.

Props andizer, SergeyBiryukov.
Fixes #47568.

Location:

trunk/tests/phpunit/includes

Files:

• exceptions.php (modified) (2 diffs)
• testcase-ajax.php (modified) (13 diffs)

trunk/tests/phpunit/includes/exceptions.php

@@ -6 +6 @@
 
 /**
- * General exception for wp_die()
+ * General exception for wp_die().
  */
 class WPDieException extends Exception {}
 
 /**
- * Exception for cases of wp_die(), for ajax tests.
- * This means there was an error (no output, and a call to wp_die)
+ * Exception for cases of wp_die(), for Ajax tests.
+ *
+ * This means there was an error (no output, and a call to wp_die).
  *
  * @package    WordPress
@@ -21 +22 @@
 
 /**
- * Exception for cases of wp_die(), for ajax tests.
- * This means execution of the ajax function should be halted, but the unit
- * test can continue.  The function finished normally and there was not an
- * error (output happened, but wp_die was called to end execution)  This is
- * used with WP_Ajax_Response::send
+ * Exception for cases of wp_die(), for Ajax tests.
+ *
+ * This means the execution of the Ajax function should be halted, but the unit test
+ * can continue. The function finished normally and there was no error (output happened,
+ * but wp_die was called to end execution). This is used with WP_Ajax_Response::send().
  *
  * @package    WordPress

trunk/tests/phpunit/includes/testcase-ajax.php

@@ -1 +1 @@
 <?php
-/**
- * Ajax test cases
- *
- * @package    WordPress
- * @subpackage UnitTests
- * @since      3.4.0
- */
-
 /**
  * Ajax test case class
@@ -18 +10 @@
 
     /**
-     * Last AJAX response.  This is set via echo -or- wp_die.
+     * Last Ajax response. This is set via echo -or- wp_die.
      *
      * @var string
@@ -25 +17 @@
 
     /**
-     * List of ajax actions called via GET
+     * List of Ajax actions called via GET.
      *
      * @var array
@@ -41 +33 @@
 
     /**
-     * Saved error reporting level
+     * Saved error reporting level.
      *
      * @var int
@@ -48 +40 @@
 
     /**
-     * List of ajax actions called via POST
+     * List of Ajax actions called via POST.
      *
      * @var array
@@ -140 +132 @@
 
     /**
-     * Set up the test fixture.
-     * Override wp_die(), pretend to be ajax, and suppress E_WARNINGs
+     * Sets up the test fixture.
+     *
+     * Overrides wp_die(), pretends to be Ajax, and suppresses E_WARNINGs.
      */
     public function setUp() {
@@ -163 +156 @@
 
     /**
-     * Tear down the test fixture.
-     * Reset $_POST, remove the wp_die() override, restore error reporting
+     * Tears down the test fixture.
+     *
+     * Resets $_POST, removes the wp_die() override, restores error reporting.
      */
     public function tearDown() {
@@ -179 +173 @@
 
     /**
-     * Clear login cookies, unset the current user
+     * Clears login cookies, unsets the current user.
      */
     public function logout() {
@@ -190 +184 @@
 
     /**
-     * Return our callback handler
+     * Returns our callback handler
      *
      * @return callback
@@ -199 +193 @@
 
     /**
-     * Handler for wp_die()
+     * Handler for wp_die().
+     *
      * Save the output for analysis, stop execution by throwing an exception.
+     *
      * Error conditions (no output, just die) will throw <code>WPAjaxDieStopException( $message )</code>
      * You can test for this with:
@@ -212 +208 @@
      * </code>
      *
-     * @param string $message
+     * @param string $message The message to set.
+     *
+     * @throws WPAjaxDieStopException     Thrown to stop further execution.
+     * @throws WPAjaxDieContinueException Thrown to stop execution of the Ajax function,
+     *                                    but continue the unit test.
      */
     public function dieHandler( $message ) {
@@ -229 +229 @@
 
     /**
-     * Switch between user roles
-     * E.g. administrator, editor, author, contributor, subscriber
-     *
-     * @param string $role
+     * Switches between user roles.
+     *
+     * E.g. administrator, editor, author, contributor, subscriber.
+     *
+     * @param string $role The role to set.
      */
     protected function _setRole( $role ) {
@@ -242 +243 @@
 
     /**
-     * Mimic the ajax handling of admin-ajax.php
-     * Capture the output via output buffering, and if there is any, store
-     * it in $this->_last_response.
-     *
-     * @param string $action
+     * Mimics the Ajax handling of admin-ajax.php.
+     *
+     * Captures the output via output buffering, and if there is any,
+     * stores it in $this->_last_response.
+     *
+     * @param string $action The action to handle.
      */
     protected function _handleAjax( $action ) {