1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-12 09:19:40 +01:00
psalm/tests/MethodSignatureTest.php

1585 lines
52 KiB
PHP
Raw Normal View History

2016-12-15 01:24:33 +01:00
<?php
2016-12-15 01:24:33 +01:00
namespace Psalm\Tests;
2021-06-08 04:55:21 +02:00
use Psalm\Context;
2021-12-03 20:29:06 +01:00
use Psalm\Exception\CodeException;
2021-12-04 21:55:53 +01:00
use Psalm\Tests\Traits\InvalidCodeAnalysisTestTrait;
use Psalm\Tests\Traits\ValidCodeAnalysisTestTrait;
2021-06-08 04:55:21 +02:00
use const DIRECTORY_SEPARATOR;
2016-12-15 01:24:33 +01:00
class MethodSignatureTest extends TestCase
2016-12-15 01:24:33 +01:00
{
2021-12-04 21:55:53 +01:00
use ValidCodeAnalysisTestTrait;
use InvalidCodeAnalysisTestTrait;
public function testExtendSoapClientWithDocblockTypes(): void
{
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
$this->addFile(
'somefile.php',
'<?php
class A extends SoapClient
{
/**
* @param string $function_name
* @param array<mixed> $arguments
* @param array<mixed> $options default null
* @param array|SoapHeader $input_headers default null
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
* @param array<mixed> $output_headers default null
* @return mixed
*/
public function __soapCall(
$function_name,
$arguments,
$options = [],
$input_headers = [],
&$output_headers = []
) {
return $_GET["foo"];
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}
}'
);
$this->analyzeFile('somefile.php', new Context());
}
public function testExtendSoapClientWithNoDocblockTypes(): void
{
$this->addFile(
'somefile.php',
'<?php
class C extends SoapClient
2019-03-25 16:49:05 +01:00
{
public function __soapCall(
string $function_name,
2019-03-25 16:49:05 +01:00
$arguments,
$options = [],
$input_headers = [],
&$output_headers = []
) {
return $_GET["foo"];
}
}'
);
$this->analyzeFile('somefile.php', new Context());
}
2019-03-25 16:49:05 +01:00
public function testExtendSoapClientWithParamType(): void
{
$this->addFile(
'somefile.php',
'<?php
2019-03-25 16:49:05 +01:00
class C extends SoapClient
{
public function __soapCall(
string $function_name,
$arguments,
$options = [],
$input_headers = [],
&$output_headers = []
) {
return $_GET["foo"];
}
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}'
);
$this->analyzeFile('somefile.php', new Context());
}
public function testMismatchingCovariantReturnIn73(): void
{
$this->expectExceptionMessage('MethodSignatureMismatch');
2021-12-03 20:29:06 +01:00
$this->expectException(CodeException::class);
$this->project_analyzer->setPhpVersion('7.3', 'tests');
$this->addFile(
'somefile.php',
'<?php
class A {
function foo(): C {
return new C();
}
}
class B extends A {
function foo(): D {
return new D();
}
}
class C {}
class D extends C {}'
);
$this->analyzeFile('somefile.php', new Context());
}
public function testMismatchingCovariantReturnIn74(): void
{
$this->project_analyzer->setPhpVersion('7.4', 'tests');
$this->addFile(
'somefile.php',
'<?php
class A {
function foo(): C {
return new C();
}
}
class B extends A {
function foo(): D {
return new D();
}
}
class C {}
class D extends C {}'
);
$this->analyzeFile('somefile.php', new Context());
}
public function testMismatchingCovariantReturnIn73WithSelf(): void
{
$this->expectExceptionMessage('MethodSignatureMismatch');
2021-12-03 20:29:06 +01:00
$this->expectException(CodeException::class);
$this->project_analyzer->setPhpVersion('7.3', 'tests');
$this->addFile(
'somefile.php',
'<?php
class A {
function foo(): self {
return new A();
}
}
class B extends A {
function foo(): self {
return new B();
}
}'
);
$this->analyzeFile('somefile.php', new Context());
}
public function testMismatchingCovariantReturnIn74WithSelf(): void
{
$this->project_analyzer->setPhpVersion('7.4', 'tests');
$this->addFile(
'somefile.php',
'<?php
class A {
function foo(): self {
return new A();
}
}
class B extends A {
function foo(): self {
return new B();
}
}'
);
$this->analyzeFile('somefile.php', new Context());
}
public function testMismatchingCovariantParamIn73(): void
{
$this->expectExceptionMessage('MethodSignatureMismatch');
2021-12-03 20:29:06 +01:00
$this->expectException(CodeException::class);
$this->project_analyzer->setPhpVersion('7.3', 'tests');
$this->addFile(
'somefile.php',
'<?php
class A {
public function foo(D $d) : void {}
}
class B extends A {
public function foo(C $c): void {}
}
class C {}
class D extends C {}'
);
$this->analyzeFile('somefile.php', new Context());
}
public function testMismatchingCovariantParamIn74(): void
{
$this->project_analyzer->setPhpVersion('7.4', 'tests');
$this->addFile(
'somefile.php',
'<?php
class A {
public function foo(D $d) : void {}
}
class B extends A {
public function foo(C $c): void {}
}
class C {}
class D extends C {}'
);
$this->analyzeFile('somefile.php', new Context());
}
public function testExtendDocblockParamTypeWithWrongDocblockParam(): void
{
2019-05-17 00:36:36 +02:00
$this->expectExceptionMessage('ImplementedParamTypeMismatch');
2021-12-03 20:29:06 +01:00
$this->expectException(CodeException::class);
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
$this->addFile(
'somefile.php',
'<?php
class A extends SoapClient
{
/**
* @param string $function_name
* @param string $arguments
* @param array<mixed> $options default null
* @param array<mixed> $input_headers default null
* @param array<mixed> $output_headers default null
* @return mixed
*/
public function __soapCall(
$function_name,
$arguments,
$options = [],
$input_headers = [],
&$output_headers = []
) {
}
}'
);
$this->analyzeFile('somefile.php', new Context());
}
public function testExtendDocblockParamTypeWithWrongParam(): void
{
2021-12-03 20:29:06 +01:00
$this->expectException(CodeException::class);
2019-05-17 00:36:36 +02:00
$this->expectExceptionMessage('MethodSignatureMismatch');
$this->addFile(
'somefile.php',
'<?php
class A extends SoapClient
{
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
public function __soapCall(
$function_name,
string $arguments,
$options = [],
$input_headers = [],
&$output_headers = []
) {
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}
}'
);
$this->analyzeFile('somefile.php', new Context());
}
/**
2022-01-13 20:38:17 +01:00
* @return iterable<string,array{code:string,assertions?:array<string,string>,ignored_issues?:list<string>}>
*/
public function providerValidCodeParse(): iterable
{
return [
'privateArgs' => [
'code' => '<?php
class A {
2018-01-11 21:50:45 +01:00
private function foo(): void {}
}
class B extends A {
2018-01-11 21:50:45 +01:00
private function foo(int $arg): void {}
}',
],
'nullableSubclassParam' => [
'code' => '<?php
class A {
2018-01-11 21:50:45 +01:00
public function foo(string $s): ?string {
return rand(0, 1) ? $s : null;
}
}
class B extends A {
2018-01-11 21:50:45 +01:00
public function foo(?string $s): string {
return $s ?: "hello";
}
}
echo (new B)->foo(null);',
],
'nullableSubclassParamWithDefault' => [
'code' => '<?php
class A {
2018-01-11 21:50:45 +01:00
public function foo(string $s): string {
return $s;
}
}
class B extends A {
2018-01-11 21:50:45 +01:00
public function foo(string $s = null): string {
return $s ?: "hello";
}
}
echo (new B)->foo();',
],
'allowSubclassesForNonInheritedMethodParams' => [
'code' => '<?php
class A {}
class B extends A {
2018-01-11 21:50:45 +01:00
public function bar(): void {}
}
class C extends A {
2018-01-11 21:50:45 +01:00
public function bar(): void {}
}
/** @param B|C $a */
2018-01-11 21:50:45 +01:00
function foo(A $a): void {
$a->bar();
}',
],
'allowNoReturnInSubclassWithNullableReturnType' => [
'code' => '<?php
class A {
/** @return ?int */
public function foo() {
if (rand(0, 1)) return 5;
}
}
class B extends A {
public function foo() {}
}',
],
2018-01-26 16:59:30 +01:00
'selfReturnShouldBeParent' => [
'code' => '<?php
2018-01-26 16:59:30 +01:00
class A {
/** @return self */
public function foo() {
return new A();
}
2018-01-26 16:59:30 +01:00
}
class B extends A {
public function foo() {
return new A();
}
2018-01-26 16:59:30 +01:00
}',
],
2018-01-26 19:51:00 +01:00
'staticReturnShouldBeStatic' => [
'code' => '<?php
2018-01-26 19:51:00 +01:00
class A {
/** @return static */
public static function foo() {
return new static();
}
final public function __construct() {}
2018-01-26 19:51:00 +01:00
}
class B extends A {
public static function foo() {
return new static();
}
2018-01-26 19:51:00 +01:00
}
$b = B::foo();',
'assertions' => [
'$b' => 'B',
],
],
'allowSomeCovariance' => [
'code' => '<?php
interface I1 {
public function test(string $s) : ?string;
public function testIterable(array $a) : ?iterable;
}
class A1 implements I1 {
public function test(?string $s) : string {
return "value";
}
public function testIterable(?iterable $a) : array {
return [];
}
}',
],
'allowVoidToNullConversion' => [
'code' => '<?php
class A {
/** @return ?string */
public function foo() {
return rand(0, 1) ? "hello" : null;
}
}
class B extends A {
public function foo(): void {
return;
}
}
class C extends A {
/** @return void */
public function foo() {
return;
}
}
class D extends A {
/** @return null */
public function foo() {
return null;
}
}',
],
'allowNoChildClassPropertyWhenMixed' => [
'code' => '<?php
class A implements Serializable {
/** @var int */
private $id = 1;
/**
* @param string $serialized
*/
public function unserialize($serialized) : void
{
[
$this->id,
] = (array) \unserialize($serialized);
}
public function serialize() : string
{
return serialize([$this->id]);
}
2018-02-22 00:59:31 +01:00
}',
],
'clashWithCallMapClass' => [
'code' => '<?php
class HaruDestination {}
class AClass
{
public function get(): HaruDestination
{
return new HaruDestination;
}
}',
],
'classWithTraitExtendsNonAbstractWithMethod' => [
'code' => '<?php
class A {
public function foo() : void {}
}
trait T {
abstract public function foo() : void;
}
class B extends A {
use T;
}',
],
'inheritsSplClasses' => [
'code' => '<?php
namespace App;
use SplObserver;
use SplSubject;
class Observer implements \SplObserver
{
public function update(SplSubject $subject)
{
}
}
class Subject implements \SplSubject
{
public function attach(SplObserver $observer)
{
}
public function detach(SplObserver $observer)
{
}
public function notify()
{
}
}',
],
'noMixedIssueWhenInheritParamTypes' => [
'code' => '<?php
class A {
/**
* @param string $bar
* @return void
*/
public function foo($bar) {
echo $bar;
}
}
class B extends A {
public function foo($bar) {
echo "hello " . $bar;
}
}',
],
'inheritDocumentedSelf' => [
'code' => '<?php
interface I {
/**
* @param self $f
*/
public function foo(self $f) : self;
}
class C implements I {
public function foo(I $f) : I {
return new C();
}
2019-03-23 19:27:54 +01:00
}',
],
'allowInterfaceImplementation' => [
'code' => '<?php
abstract class A {
/** @return static */
public function foo() {
return $this;
}
}
interface I {
/** @return I */
public function foo();
}
class C extends A implements I {}',
],
'enforceParameterInheritanceWithInheritDocAndParam' => [
'code' => '<?php
class A {}
class B extends A {}
class X {
/**
* @param B $class
*/
public function boo(A $class): void {}
}
class Y extends X {
/**
* @inheritdoc
* @param A $class
*/
public function boo(A $class): void {}
}
2019-03-08 00:04:02 +01:00
class Z extends X {
/**
* @inheritDoc
* @param A $class
*/
public function boo(A $class): void {}
}
(new Y())->boo(new A());
(new Z())->boo(new A());',
],
'allowMixedExtensionOfIteratorAggregate' => [
'code' => '<?php
/**
* @psalm-suppress MissingTemplateParam
*/
class C implements IteratorAggregate {
public function getIterator(): Iterator {
return new ArrayIterator([]);
}
2019-03-23 19:27:54 +01:00
}',
],
2019-03-02 21:26:18 +01:00
'allowExtraVariadic' => [
'code' => '<?php
2019-03-02 21:26:18 +01:00
interface I {
public function f(string $a, int $b): void;
}
class C implements I {
public function f(string $a = "a", int $b = 1, float ...$rest): void {}
}
(new C)->f();
(new C)->f("b");
(new C)->f("b", 3);
(new C)->f("b", 3, 0.5);
2019-03-23 19:27:54 +01:00
(new C)->f("b", 3, 0.5, 0.8);',
2019-03-02 21:26:18 +01:00
],
'allowLessSpecificDocblockTypeOnParent' => [
'code' => '<?php
abstract class Foo {
/**
* @return array|string
*/
abstract public function getTargets();
}
class Bar extends Foo {
public function getTargets(): string {
return "baz";
}
}
$a = (new Bar)->getTargets();',
'assertions' => [
'$a' => 'string',
2019-07-05 22:24:00 +02:00
],
],
'parentIsKnown' => [
'code' => '<?php
class A {
public function returnSelf() : self {
return $this;
}
}
class B extends A {
public function returnSelf() : parent {
return parent::returnSelf();
}
}',
],
'returnStaticParent' => [
'code' => '<?php
class A {
/**
* @return static
*/
public static function foo() {
return new static();
}
final public function __construct() {}
}
class B extends A {
/**
* @return static
*/
public static function foo() {
return parent::foo();
}
}',
],
'selfInTraitAbstractIsFine' => [
'code' => '<?php
trait SomeTrait {
abstract public function a(self $b): self;
}
class SomeClass {
use SomeTrait;
public function a(self $b): self {
return $this;
}
}'
],
'allowMatchIn74' => [
'code' => '<?php
trait FooTrait {
/**
* @return static
*/
public function bar(): self {
return $this;
}
}
interface FooInterface {
/**
* @return static
*/
public function bar(): self;
}
class FooClass implements FooInterface {
use FooTrait;
}',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '7.4'
],
'allowOverridingThrowable' => [
'code' => '<?php
/**
* @psalm-immutable
*/
interface MyException extends \Throwable
{
/**
* Informative comment
*/
public function getMessage(): string;
public function getCode();
public function getFile(): string;
public function getLine(): int;
public function getTrace(): array;
public function getPrevious(): ?\Throwable;
public function getTraceAsString(): string;
}'
],
'allowExecptionToStringWithNoType' => [
'code' => '<?php
class E extends Exception {
public function __toString() {
return "hello";
}
}'
],
'allowExecptionToStringIn71' => [
'code' => '<?php
class E extends Exception {
public function __toString() : string {
return "hello";
}
}',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '7.1'
],
'consistentConstructor' => [
'code' => '<?php
/**
* @psalm-consistent-constructor
*/
class A {
public function getInstance() : self {
return new static();
}
}
class AChild extends A {
public function __construct() {}
}'
],
'allowStaticInheritance' => [
'code' => '<?php
class A {
public function method(): static {
return $this;
}
}
class B extends A {
public function method(): static {
return $this;
}
}',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '8.0'
],
'suppressDocblockFinal' => [
'code' => '<?php
/**
* @final
*/
class A {
public function foo(): void {}
}
/**
* @psalm-suppress InvalidExtendClass
*/
class B extends A {
/**
* @psalm-suppress MethodSignatureMismatch
*/
public function foo(): void {}
}'
],
'inheritParamTypeWhenSignatureReturnTypeChanged' => [
'code' => '<?php
class A {
public function __construct(string $s) {}
}
class AChild extends A {}
interface B {
/** @param string $data */
public function create($data): A;
}
class C implements B {
public function create($data): AChild {
return new AChild($data);
}
}',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '7.4'
],
'extendStaticReturnTypeInFinal' => [
'code' => '<?php
final class B extends A
{
public static function doCretate1(): self
{
return self::create1();
}
public static function doCretate2(): self
{
return self::create2();
}
}
abstract class A
{
final private function __construct() {}
final protected static function create1(): static
{
return new static();
}
/** @return static */
final protected static function create2()
{
return new static();
}
}',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '8.0'
],
'notExtendedStaticReturntypeInFinal' => [
'code' => '<?php
final class X
{
public static function create(): static
{
return new self();
}
}'
],
'callParentMethodFromTrait' => [
'code' => '<?php
class MyParentClass
{
/** @return static */
public function myMethod()
{
return $this;
}
}
trait MyTrait
{
final public function myMethod() : self
{
return parent::myMethod();
}
}
class MyChildClass extends MyParentClass
{
use MyTrait;
}'
],
2021-05-15 02:23:54 +02:00
'MixedParamInImplementation' => [
'code' => '<?php
2021-05-15 02:23:54 +02:00
interface I
{
/**
* @param mixed $a
*/
public function a($a): void;
}
final class B implements I
{
public function a(mixed $a): void {}
}'
],
];
}
/**
2022-01-13 20:38:17 +01:00
* @return iterable<string,array{code:string,error_message:string,ignored_issues?:list<string>,php_version?:string}>
*/
public function providerInvalidCodeParse(): iterable
{
return [
'oneParam' => [
'code' => '<?php
interface I {
/**
* @param array $i
*/
public function foo(array $i) : void;
}
class C implements I {
public function foo(array $c) : void {
return;
}
}',
'error_message' => 'Argument 1 of C::foo has wrong name $c, expecting $i as defined by I::foo',
],
'moreArguments' => [
'code' => '<?php
class A {
2018-01-11 21:50:45 +01:00
public function fooFoo(int $a, bool $b): void {
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}
}
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
class B extends A {
2018-01-11 21:50:45 +01:00
public function fooFoo(int $a, bool $b, array $c): void {
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}
}',
'error_message' => 'Method B::fooFoo has more required parameters than parent method A::fooFoo',
],
'fewerArguments' => [
'code' => '<?php
class A {
2018-01-11 21:50:45 +01:00
public function fooFoo(int $a, bool $b): void {
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}
}
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
class B extends A {
2018-01-11 21:50:45 +01:00
public function fooFoo(int $a): void {
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}
}',
'error_message' => 'Method B::fooFoo has fewer parameters than parent method A::fooFoo',
],
'differentArgumentTypes' => [
'code' => '<?php
class A {
2018-01-11 21:50:45 +01:00
public function fooFoo(int $a, bool $b): void {
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}
}
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
class B extends A {
public function fooFoo(int $a, int $b): void {
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}
}',
'error_message' => 'Argument 2 of B::fooFoo has wrong type \'int\', expecting \'bool\' as defined ' .
'by A::fooFoo',
2017-05-27 02:05:57 +02:00
],
'differentArgumentNames' => [
'code' => '<?php
class A {
public function fooFoo(int $a, bool $b): void {
}
}
class B extends A {
public function fooFoo(int $a, bool $c): void {
}
}',
'error_message' => 'ParamNameMismatch',
],
'nonNullableSubclassParam' => [
'code' => '<?php
class A {
2018-01-11 21:50:45 +01:00
public function foo(?string $s): string {
return $s ?: "hello";
}
}
class B extends A {
2018-01-11 21:50:45 +01:00
public function foo(string $s): string {
return $s;
}
}',
'error_message' => 'Argument 1 of B::foo has wrong type \'string\', expecting \'null|string\' as',
],
2017-12-30 16:54:01 +01:00
'misplacedRequiredParam' => [
'code' => '<?php
function foo(string $bar = null, int $bat): void {}
foo();',
'error_message' => 'TooFewArguments',
2017-12-30 16:54:01 +01:00
],
'clasginByRef' => [
'code' => '<?php
class A {
2018-01-11 21:50:45 +01:00
public function foo(string $a): void {
echo $a;
}
}
class B extends A {
2018-01-11 21:50:45 +01:00
public function foo(string &$a): void {
echo $a;
}
}',
'error_message' => 'MethodSignatureMismatch',
],
'disallowSubclassesForNonInheritedMethodParams' => [
'code' => '<?php
class A {}
class B extends A {
2018-01-11 21:50:45 +01:00
public function bar(): void {}
}
class C extends A {
2018-01-11 21:50:45 +01:00
public function bar(): void {}
}
class D {
2018-01-11 21:50:45 +01:00
public function foo(A $a): void {}
}
class E extends D {
/** @param B|C $a */
2018-01-11 21:50:45 +01:00
public function foo(A $a): void {
$a->bar();
}
}',
'error_message' => 'MoreSpecificImplementedParamType',
],
'preventVoidToNullConversionSignature' => [
'code' => '<?php
class A {
public function foo(): ?string {
return rand(0, 1) ? "hello" : null;
}
}
class B extends A {
public function foo(): void {
return;
}
}',
'error_message' => 'MethodSignatureMismatch',
],
'abstractExtendsNonAbstractWithMethod' => [
'code' => '<?php
class A {
public function foo() : void {}
}
abstract class B extends A {
abstract public function foo() : void;
}',
'error_message' => 'MethodSignatureMismatch',
],
'traitReturnTypeMismatch' => [
'code' => '<?php
class A {
public function foo() : void {}
}
trait T {
abstract public function foo() : string;
}
class B extends A {
use T;
}',
'error_message' => 'MethodSignatureMismatch',
],
'abstractTraitMethodWithDifferentReturnType' => [
'code' => '<?php
class A {}
class B {}
trait T {
abstract public function foo() : A;
}
class C {
use T;
public function foo() : B{
return new B();
}
}',
'error_message' => 'TraitMethodSignatureMismatch',
],
'traitMoreParams' => [
'code' => '<?php
class A {
public function foo() : void {}
}
trait T {
abstract public function foo(string $s) : string;
}
class B extends A {
use T;
}',
'error_message' => 'MethodSignatureMismatch',
],
'abstractTraitMethodWithDifferentParamType' => [
'code' => '<?php
class A {}
class B {}
trait T {
abstract public function foo(A $a) : void;
}
class C {
use T;
public function foo(B $a) : void {}
}',
'error_message' => 'TraitMethodSignatureMismatch',
],
2018-04-21 21:59:16 +02:00
'mustOmitReturnType' => [
'code' => '<?php
2018-04-21 21:59:16 +02:00
class A
{
public function __construct(): void
{
}
}',
'error_message' => 'MethodSignatureMustOmitReturnType',
],
'requireParam' => [
'code' => '<?php
interface I {
function foo(bool $b = false): void;
}
class C implements I {
public function foo(bool $b): void {}
}',
2019-02-27 22:00:44 +01:00
'error_message' => 'MethodSignatureMismatch - src' . DIRECTORY_SEPARATOR . 'somefile.php:6:27 - Method C::foo has more required',
],
'inheritParamTypes' => [
'code' => '<?php
class A {
/**
* @param string $bar
* @return void
*/
public function foo($bar) {
echo $bar;
}
}
class B extends A {
public function foo($bar) {
echo "hello " . $bar;
}
}
(new B)->foo(new stdClass);',
2019-03-23 19:27:54 +01:00
'error_message' => 'InvalidArgument',
],
'interfaceHasFewerConstructorArgs' => [
'code' => '<?php
interface Foo {
public function __construct();
}
class Bar implements Foo {
public function __construct(bool $foo) {}
}',
'error_message' => 'ConstructorSignatureMismatch',
],
'enforceParameterInheritanceWithInheritDoc' => [
'code' => '<?php
class A {}
class B extends A {}
class X {
/**
* @param B $class
*/
public function boo(A $class): void {}
}
class Y extends X {
/**
* @inheritdoc
*/
public function boo(A $class): void {}
}
(new Y())->boo(new A());',
'error_message' => 'ArgumentTypeCoercion',
],
2019-03-08 00:04:02 +01:00
'enforceParameterInheritanceWithCapitalizedInheritDoc' => [
'code' => '<?php
2019-03-08 00:04:02 +01:00
class A {}
class B extends A {}
class X {
/**
* @param B $class
*/
public function boo(A $class): void {}
}
class Y extends X {
/**
* @inheritDoc
*/
public function boo(A $class): void {}
}
(new Y())->boo(new A());',
'error_message' => 'ArgumentTypeCoercion',
2019-03-08 00:04:02 +01:00
],
'warnAboutMismatchingClassParamDoc' => [
'code' => '<?php
class A {}
class B {}
class X {
/**
* @param B $class
*/
public function boo(A $class): void {}
}',
'error_message' => 'MismatchingDocblockParamType',
],
'warnAboutMismatchingInterfaceParamDoc' => [
'code' => '<?php
class A {}
class B {}
interface X {
/**
* @param B $class
*/
public function boo(A $class): void {}
}',
'error_message' => 'MismatchingDocblockParamType',
],
'interfaceInsertDocblockTypes' => [
'code' => '<?php
class Foo {}
class Bar {}
interface I {
/** @return array<int, Foo> */
public function getFoos() : array;
}
class A implements I {
public function getFoos() : array {
return [new Bar()];
}
}',
'error_message' => 'InvalidReturnStatement',
],
'classInsertDocblockTypesFromParent' => [
'code' => '<?php
class Foo {}
class Bar {}
class B {
/** @return array<int, Foo> */
public function getFoos() : array {
return [new Foo()];
}
}
class A extends B {
public function getFoos() : array {
return [new Bar()];
}
}',
'error_message' => 'InvalidReturnStatement',
],
2019-03-02 21:29:43 +01:00
'preventInterfaceOverload' => [
'code' => '<?php
2019-03-02 21:29:43 +01:00
interface I {
public function f(float ...$rest): void;
}
class C implements I {
/**
* @param array<int,float> $f
* @psalm-suppress ParamNameMismatch
*/
2019-03-02 21:29:43 +01:00
public function f($f): void {}
}',
'error_message' => 'MethodSignatureMismatch',
'ignored_issues' => ['MoreSpecificImplementedParamType'],
2019-03-02 21:29:43 +01:00
],
'preventOneOfUnionMoreSpecific' => [
'code' => '<?php
class A {
/** @param string|int $s */
public function foo($s) : void {}
}
class B extends A {
/** @param string $s */
public function foo($s) : void {}
}',
'error_message' => 'MoreSpecificImplementedParamType',
],
'preventImplementingSerializableWithWrongDocblockType' => [
'code' => '<?php
class Foo implements \Serializable {
/** @param int $serialized */
public function unserialize($serialized) {}
public function serialize() {}
}',
'error_message' => 'ImplementedParamTypeMismatch',
],
'returnsParentWithNoParent' => [
'code' => '<?php
class Foo {
public function f(): parent {}
}
',
'error_message' => 'InvalidParent',
],
'returnsParentWithNoParentAndInvalidParentSuppressed' => [
'code' => '<?php
class Foo {
public function f(): parent {
}
}
',
'error_message' => 'InvalidReturnType',
'ignored_issues' => ['InvalidParent'],
],
// not sure how to handle it
'SKIPPED-returnsParentWithNoParentAndInvalidParentSuppressedMismatchingReturn' => [
'code' => '<?php
class Foo {
public function f(): parent {
return false;
}
}
',
'error_message' => 'InvalidReturnType',
'ignored_issues' => ['InvalidParent'],
],
'regularMethodMismatchFromParentUse' => [
'code' => '<?php
trait T2 {
abstract public function test(int $x) : void;
}
abstract class P2 {
use T2;
}
class C2 extends P2 {
public function test(string $x) : void {}
}',
'error_message' => 'MethodSignatureMismatch',
],
'regularMethodMismatchFromChildUse' => [
'code' => '<?php
trait T3 {
abstract public function test(int $x) : void;
}
class P3 {
public function test(string $x) : void {}
}
class C3 extends P3 {
use T3;
}',
'error_message' => 'MethodSignatureMismatch',
],
'traitMethodAccessLevel' => [
'code' => '<?php
class A {}
class B extends A {}
trait T1 {
abstract protected static function test(A $x) : void;
}
class C1 {
use T1;
private static function test(B $x) : void {}
}',
'error_message' => 'TraitMethodSignatureMismatch',
],
'abstractClassReturnMismatch' => [
'code' => '<?php
interface I {
function foo(): array;
}
abstract class C implements I {
public function foo(): void {}
}',
'error_message' => 'MethodSignatureMismatch',
],
'abstractClassParamMismatch' => [
'code' => '<?php
interface I {
function foo(int $s): void;
}
abstract class C implements I {
public function foo(string $s): void {}
}',
'error_message' => 'MethodSignatureMismatch',
],
'preventTraitMatchIn73' => [
'code' => '<?php
trait FooTrait {
/**
* @return static
*/
public function bar(): self {
return $this;
}
}
interface FooInterface {
/**
* @return static
*/
public function bar(): self;
}
class FooClass implements FooInterface {
use FooTrait;
}',
'error_message' => 'MethodSignatureMismatch',
'ignored_issues' => [],
'php_version' => '7.3'
],
'inconsistentConstructorExplicitParentConstructorArgCount' => [
'code' => '<?php
/**
* @psalm-consistent-constructor
*/
class A {
public function getInstance() : self
{
return new static();
}
public function __construct() {}
}
class BadAChild extends A {
public function __construct(string $s) {}
}',
'error_message' => 'ConstructorSignatureMismatch',
],
'inconsistentConstructorExplicitParentConstructorType' => [
'code' => '<?php
/**
* @psalm-consistent-constructor
*/
class A {
public function getInstance() : self
{
return new static(5);
}
public function __construct(int $s) {}
}
class BadAChild extends A {
public function __construct(string $s) {}
}',
'error_message' => 'ConstructorSignatureMismatch',
],
'inconsistentConstructorImplicitParentConstructor' => [
'code' => '<?php
/**
* @psalm-consistent-constructor
*/
class A {
public function getInstance() : self {
return new static();
}
}
class BadAChild extends A {
public function __construct(string $s) {}
}',
'error_message' => 'ConstructorSignatureMismatch',
],
'inheritDocblockReturnFromInterface' => [
'code' => '<?php
interface A {
/** @return ?string */
function foo();
}
class C implements A {
public function foo() : ?string {}
}',
'error_message' => 'InvalidReturnType',
],
'disableNamedArgumentsInDescendant' => [
'code' => '<?php
interface Foo {
public function bar(string ...$_args): void;
}
final class Baz implements Foo {
/** @no-named-arguments */
public function bar(string ...$_args): void {}
}
',
'error_message' => 'MethodSignatureMismatch',
],
'SKIPPED-noMixedTypehintInDescendant' => [
2022-01-22 18:05:32 +01:00
'code' => '<?php
class a {
public function test(): mixed {
return 0;
}
}
class b extends a {
public function test() {
return 0;
}
}
',
2022-01-19 12:33:16 +01:00
'error_message' => 'MethodSignatureMismatch',
2022-01-22 18:05:32 +01:00
'ignored_issues' => [],
'8.0'
],
'noTypehintInNativeDescendant' => [
2022-01-22 18:05:32 +01:00
'code' => '<?php
class a implements JsonSerializable {
public function jsonSerialize() {
return 0;
}
}
',
2022-01-19 12:20:50 +01:00
'error_message' => 'MethodSignatureMustProvideReturnType',
2022-01-22 18:05:32 +01:00
'ignored_issues' => [],
'8.1'
],
];
}
2016-12-15 01:24:33 +01:00
}