phpstan/phpstan-mockery

PHPStan Mockery extension

2.0.0 2024-10-14 03:18 UTC

Requires

• php: ^7.4 || ^8.0
• phpstan/phpstan: ^2.0

Requires (Dev)

• mockery/mockery: ^1.6.11
• php-parallel-lint/php-parallel-lint: ^1.2
• phpstan/phpstan-phpunit: ^2.0
• phpstan/phpstan-strict-rules: ^2.0
• phpunit/phpunit: ^9.6

MIT

README

• PHPStan
• Mockery

This extension provides the following features:

• Mockery::mock(), Mockery::spy(), and Mockery::namedMock() return an intersection type (e.g. Foo&MockInterface) so that the mock can be used as both the mocked class and a mock object. See the detailed explanation of intersection types.
• Interprets Foo|\Mockery\MockInterface in phpDoc so that it results in an intersection type instead of a union type. This can be disabled by setting the mockery.convertUnionToIntersectionType parameter to false.
• shouldReceive(), shouldNotReceive(), shouldHaveReceived(), shouldNotHaveReceived(), allows(), and expects() methods are understood on mock objects.
• makePartial() and shouldAllowMockingProtectedMethods() return static, preserving the intersection type for chained calls.
• Alias (alias:) and overload (overload:) mock prefixes are handled.
• Partial mock syntax (ClassName[methodName]) is supported.
• Multiple interfaces passed as comma-separated strings or as separate arguments are resolved.
• Constructor argument arrays passed to mock() are handled correctly.

Installation

To use this extension, require it in Composer:

composer require --dev phpstan/phpstan-mockery

If you also install phpstan/extension-installer then you're all set!

Manual installation

If you don't want to use phpstan/extension-installer, include extension.neon in your project's PHPStan config:

includes:
    - vendor/phpstan/phpstan-mockery/extension.neon