Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update return type for mockPost() #226

Merged
merged 4 commits into from
Jul 20, 2023
Merged

Update return type for mockPost() #226

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c9f604
Update return type for mockPost()
wvega-godaddy Jul 19, 2023
7f2fae0
Update return type of mockPost()
wvega Jul 19, 2023
f32043b
Update return type of mockWp()
wvega Jul 19, 2023
5691885
Merge branch 'trunk' into chore/update-returned-type-for-mock-post
unfulvio-godaddy Jul 20, 2023
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
13 changes: 11 additions & 2 deletions php/WP_Mock/Traits/MockWordPressObjectsTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
namespace WP_Mock\Traits;

use Mockery;
use Mockery\LegacyMockInterface;
use Mockery\MockInterface;
use WP;
use WP_Post;

Expand All @@ -14,12 +16,18 @@ trait MockWordPressObjectsTrait
/**
* Mocks a WordPress post.
*
* Users of this method should add `@var WP_Post $variable` or `@var Mockery\MockInterface $variable` to
* set the necessary type for the resulting mock. Unfortunately, PHPStan doesn't allow WP_Post in an
* intersection type, because the class is marked as final.
*
* @param array<string, mixed> $postData optional post data to add to the post
* @return Mockery\LegacyMockInterface|Mockery\MockInterface|WP_Post|(WP_Post&Mockery\LegacyMockInterface)|(WP_Post&Mockery\MockInterface)
* @return Mockery\LegacyMockInterface&Mockery\MockInterface
*/
protected function mockPost(array $postData = [])
{
/** @var Mockery\LegacyMockInterface&Mockery\MockInterface $post */
$post = Mockery::mock(WP_Post::class);

$postData = array_merge([
'ID' => 0,
'post_author' => 0,
Expand Down Expand Up @@ -52,10 +60,11 @@ protected function mockPost(array $postData = [])
* Mocks a WordPress instance.
*
* @param array<string, mixed> $queryVars
* @return Mockery\LegacyMockInterface|Mockery\MockInterface|WP|(WP&Mockery\LegacyMockInterface)|(WP&Mockery\MockInterface)
* @return WP&LegacyMockInterface&MockInterface
*/
protected function mockWp(array $queryVars = [])
{
/** @var WP&Mockery\LegacyMockInterface&Mockery\MockInterface $wp */
$wp = Mockery::mock(WP::class);
/** @phpstan-ignore-next-line */
$wp->query_vars = $queryVars;
Expand Down
Loading