Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions php/WP_Mock/HookedCallback.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,29 @@ public function react($callback, $priority, $argument_count)

$safe_callback = $this->safe_offset($callback);

if (is_array($callback)) {
$any_instance_callback = array( new AnyInstance($callback[0]), $callback[1] );
$safe_any_instance_callback = $this->safe_offset($any_instance_callback);
if (! empty($this->processors[ $safe_any_instance_callback ])) {
$safe_callback = $safe_any_instance_callback;
if (is_array($callback) && count($callback) === 2 && method_exists($callback[0], $callback[1])) {
$isEnum = false;
if(method_exists(\ReflectionClass::class, 'isEnum')) {
try {
$rc = new \ReflectionClass($callback[0]);
/** @phpstan-ignore-next-line (requires PHP 8.1+) */
$isEnum = $rc->isEnum();
} catch (\ReflectionException $e) {
// Unreachable: method_exists() above guarantees the class exists.
}
}
try {
$isStatic = (new \ReflectionMethod($callback[0], $callback[1]))->isStatic();
} catch (\ReflectionException $e) {
// Unreachable: method_exists() above guarantees the method exists.
$isStatic = false;
}
if(!$isEnum && !$isStatic) {
$any_instance_callback = array( new AnyInstance( $callback[0] ), $callback[1] );
$safe_any_instance_callback = $this->safe_offset( $any_instance_callback );
if ( ! empty( $this->processors[ $safe_any_instance_callback ] ) ) {
$safe_callback = $safe_any_instance_callback;
}
}
}
Comment on lines +26 to 50

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest narrowing this to just the enum-class-name case, so static methods and __call methods keep matching AnyInstance expectations:

Suggested change
if (is_array($callback) && count($callback) === 2 && method_exists($callback[0], $callback[1])) {
$isEnum = false;
if(method_exists(\ReflectionClass::class, 'isEnum')) {
try {
$rc = new \ReflectionClass($callback[0]);
/** @phpstan-ignore-next-line (requires PHP 8.1+) */
$isEnum = $rc->isEnum();
} catch (\ReflectionException $e) {
// Unreachable: method_exists() above guarantees the class exists.
}
}
try {
$isStatic = (new \ReflectionMethod($callback[0], $callback[1]))->isStatic();
} catch (\ReflectionException $e) {
// Unreachable: method_exists() above guarantees the method exists.
$isStatic = false;
}
if(!$isEnum && !$isStatic) {
$any_instance_callback = array( new AnyInstance( $callback[0] ), $callback[1] );
$safe_any_instance_callback = $this->safe_offset( $any_instance_callback );
if ( ! empty( $this->processors[ $safe_any_instance_callback ] ) ) {
$safe_callback = $safe_any_instance_callback;
}
}
}
// AnyInstance cannot instantiate an enum from its class name.
if (is_array($callback) && ! (is_string($callback[0]) && is_a($callback[0], 'UnitEnum', true))) {
$any_instance_callback = array( new AnyInstance($callback[0]), $callback[1] );
$safe_any_instance_callback = $this->safe_offset($any_instance_callback);
if (! empty($this->processors[ $safe_any_instance_callback ])) {
$safe_callback = $safe_any_instance_callback;
}
}


Expand Down
3 changes: 3 additions & 0 deletions phpstan.neon
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ parameters:
paths:
- php
- tests
excludePaths:
# Enum syntax; phpstan analyses as PHP 7.4 (composer platform config). Only loaded at runtime on 8.1+.
- tests/Mocks/SampleEnum.php
bootstrapFiles:
- vendor/php-stubs/wordpress-globals/wordpress-globals.php
- vendor/php-stubs/wordpress-stubs/wordpress-stubs.php
Expand Down
41 changes: 41 additions & 0 deletions tests/Integration/WP_MockTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,47 @@ public function testCanExpectHooksAdded() : void
add_action('wpMockTestAction', 'wpMockTestFunction', 10, 2);
add_filter('wpMockTestFilter', 'wpMockTestFunction', 10, 2);

WP_Mock::expectActionAdded('wpMockTestAction', array(\WP_Mock\Tests\Mocks\SampleClass::class, 'staticMethod'));
add_action('wpMockTestAction', array(\WP_Mock\Tests\Mocks\SampleClass::class, 'staticMethod'));

$sampleClassInstance = new \WP_Mock\Tests\Mocks\SampleClass();
WP_Mock::expectActionAdded('wpMockTestAction', array($sampleClassInstance, 'action'), 10, 2);
add_action('wpMockTestAction', array($sampleClassInstance, 'action'), 10, 2);

/**
* PHP 8.1 First Class Callable – `$instance->method( ... )`.
*
* If we use PHP 8.1 syntax in this file it will fail to parse when run under older versions, so we
* will use `eval()` for now.
*
* @see https://www.php.net/manual/en/functions.first_class_callable_syntax.php
*/
if(PHP_VERSION_ID >= 80100) {
$php81FirstClassCallableSyntaxPhpString = <<<'EOD'
WP_Mock::expectActionAdded('wpMockTestAction', $sampleClassInstance->action( ... ), 10, 2);
add_action('wpMockTestAction', $sampleClassInstance->action( ... ), 10, 2);
EOD;
eval($php81FirstClassCallableSyntaxPhpString);
}

/**
* @see https://www.php.net/manual/en/language.enumerations.methods.php
* @see https://www.php.net/manual/en/language.enumerations.static-methods.php
*/
if(PHP_VERSION_ID >= 80100) {
$php81EnumMethodPhpString = <<<'EOD'
WP_Mock::expectActionAdded('wpMockTestAction', array(\WP_Mock\Tests\Mocks\SampleEnum::Code, 'method'));
add_action('wpMockTestAction', array(\WP_Mock\Tests\Mocks\SampleEnum::Code, 'method'));

WP_Mock::expectActionAdded('wpMockTestAction', array(\WP_Mock\Tests\Mocks\SampleEnum::class, 'staticMethod'));
add_action('wpMockTestAction', array(\WP_Mock\Tests\Mocks\SampleEnum::class, 'staticMethod'));

WP_Mock::expectActionAdded('wpMockTestAction', array(\WP_Mock\Functions::type(\WP_Mock\Tests\Mocks\SampleEnum::class), 'method'));
add_action('wpMockTestAction', array(\WP_Mock\Tests\Mocks\SampleEnum::Code, 'method'));
EOD;
eval($php81EnumMethodPhpString);
}

WP_Mock::assertHooksAdded();
}

Expand Down
4 changes: 4 additions & 0 deletions tests/Mocks/SampleClass.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,8 @@ class SampleClass
public function action(): void
{
}

public static function staticMethod(): void
{
}
}
16 changes: 16 additions & 0 deletions tests/Mocks/SampleEnum.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php

namespace WP_Mock\Tests\Mocks;

enum SampleEnum
{
case Code;

public function method(): void
{
}

public static function staticMethod(): void
{
}
}
Loading