Build/Test Tools: Fix typing and logic issues in MockAction.

* Add type information.
* Fix erroneous fallback case for `MockAction::current_filter()` in how it gets the last key of `$wp_actions`.
* Fix `MockAction::get_call_count()` to handle getting counts of a provided filter in addition to a provided action.

Developed in WordPress#12618.

See #64898, #64894.



git-svn-id: https://develop.svn.wordpress.org/trunk@62808 602fd350-edb4-49c9-b593-d223f7449a82

Author: westonruter

tests/phpunit/includes/utils.php

@@ -58,43 +58,73 @@ function strip_ws( $txt ) {
  *     add_action( 'foo', array( &$ma, 'action' ) );
  *
  * @since UT (3.7.0)
+ *
+ * @phpstan-type Hook_Event array{
+ *     action?: non-empty-string,
+ *     filter?: non-empty-string,
+ *     hook_name: string|false,
+ *     tag: string|false,
+ *     args: list<mixed>,
+ * }
  */
 class MockAction {
+
+	/**
+	 * @var list<Hook_Event>
+	 */
 	public $events;
+
+	/**
+	 * @var bool
+	 */
 	public $debug;
 
 	/**
 	 * PHP5 constructor.
 	 *
 	 * @since UT (3.7.0)
+	 *
+	 * @param bool|int $debug
 	 */
 	public function __construct( $debug = 0 ) {
 		$this->reset();
-		$this->debug = $debug;
+		$this->debug = (bool) $debug;
 	}
 
 	/**
 	 * @since UT (3.7.0)
 	 */
-	public function reset() {
+	public function reset(): void {
 		$this->events = array();
 	}
 
 	/**
 	 * @since UT (3.7.0)
+	 *
+	 * @global array<non-empty-string, non-negative-int> $wp_actions
+	 * @return string|false
 	 */
 	public function current_filter() {
 		global $wp_actions;
 
 		if ( is_callable( 'current_filter' ) ) {
-			return current_filter();
+			$current_filter = current_filter();
+		} else {
+			$current_filter = array_key_last( $wp_actions );
+			if ( null === $current_filter ) {
+				$current_filter = false;
+			}
 		}
 
-		return end( $wp_actions );
+		return $current_filter;
 	}
 
 	/**
 	 * @since UT (3.7.0)
+	 *
+	 * @template T
+	 * @param T $arg
+	 * @return T
 	 */
 	public function action( $arg ) {
 		$current_filter = $this->current_filter();
@@ -115,6 +145,10 @@ public function action( $arg ) {
 
 	/**
 	 * @since UT (3.7.0)
+	 *
+	 * @template T
+	 * @param T $arg
+	 * @return T
 	 */
 	public function action2( $arg ) {
 		$current_filter = $this->current_filter();
@@ -135,6 +169,10 @@ public function action2( $arg ) {
 
 	/**
 	 * @since UT (3.7.0)
+	 *
+	 * @template T
+	 * @param T $arg
+	 * @return T
 	 */
 	public function filter( $arg ) {
 		$current_filter = $this->current_filter();
@@ -155,6 +193,10 @@ public function filter( $arg ) {
 
 	/**
 	 * @since UT (3.7.0)
+	 *
+	 * @template T
+	 * @param T $arg
+	 * @return T
 	 */
 	public function filter2( $arg ) {
 		$current_filter = $this->current_filter();
@@ -175,8 +217,12 @@ public function filter2( $arg ) {
 
 	/**
 	 * @since UT (3.7.0)
+	 *
+	 * @no-named-arguments
+	 * @param string $arg
+	 * @return non-empty-string
 	 */
-	public function filter_append( $arg ) {
+	public function filter_append( $arg ): string {
 		$current_filter = $this->current_filter();
 
 		if ( $this->debug ) {
@@ -197,8 +243,12 @@ public function filter_append( $arg ) {
 	 * Does not return the result, so it's safe to use with the 'all' filter.
 	 *
 	 * @since UT (3.7.0)
+	 *
+	 * @no-named-arguments
+	 * @param string $hook_name
+	 * @param mixed ...$args
 	 */
-	public function filterall( $hook_name, ...$args ) {
+	public function filterall( string $hook_name, ...$args ): void {
 		$current_filter = $this->current_filter();
 
 		if ( $this->debug ) {
@@ -217,22 +267,30 @@ public function filterall( $hook_name, ...$args ) {
 	 * Returns a list of all the actions, hook names and args.
 	 *
 	 * @since UT (3.7.0)
+	 *
+	 * @return list<Hook_Event>
 	 */
-	public function get_events() {
+	public function get_events(): array {
 		return $this->events;
 	}
 
 	/**
 	 * Returns a count of the number of times the action was called since the last reset.
 	 *
 	 * @since UT (3.7.0)
+	 *
+	 * @param string $hook_name Hook name.
+	 * @return non-negative-int
 	 */
-	public function get_call_count( $hook_name = '' ) {
+	public function get_call_count( $hook_name = '' ): int {
 		if ( $hook_name ) {
 			$count = 0;
 
 			foreach ( $this->events as $e ) {
-				if ( $e['action'] === $hook_name ) {
+				if (
+					( isset( $e['action'] ) && $e['action'] === $hook_name ) ||
+					( isset( $e['filter'] ) && $e['filter'] === $hook_name )
+				) {
 					++$count;
 				}
 			}
@@ -247,8 +305,10 @@ public function get_call_count( $hook_name = '' ) {
 	 * Returns an array of the hook names that triggered calls to this action.
 	 *
 	 * @since 6.1.0
+	 *
+	 * @return list<string|false>
 	 */
-	public function get_hook_names() {
+	public function get_hook_names(): array {
 		$out = array();
 
 		foreach ( $this->events as $e ) {
@@ -263,17 +323,21 @@ public function get_hook_names() {
 	 *
 	 * @since UT (3.7.0)
 	 * @since 6.1.0 Turned into an alias for ::get_hook_names().
+	 *
+	 * @return list<string|false>
 	 */
-	public function get_tags() {
+	public function get_tags(): array {
 		return $this->get_hook_names();
 	}
 
 	/**
 	 * Returns an array of args passed in calls to this action.
 	 *
 	 * @since UT (3.7.0)
+	 *
+	 * @return list<list<mixed>>
 	 */
-	public function get_args() {
+	public function get_args(): array {
 		$out = array();
 
 		foreach ( $this->events as $e ) {