Inherit PHPDocs from internal classes

ondrejmirtes · ondrejmirtes · commit e6865059b45b · 2020-05-22T18:31:39.000+02:00
diff --git a/composer.json b/composer.json
@@ -20,7 +20,7 @@
 		"nette/utils": "^3.1.1",
 		"nikic/php-parser": "^4.4.0",
 		"ondram/ci-detector": "^3.1",
-		"ondrejmirtes/better-reflection": "^4.2.12",
+		"ondrejmirtes/better-reflection": "^4.2.13",
 		"phpstan/phpdoc-parser": "^0.4.7",
 		"react/child-process": "^0.6.1",
 		"react/event-loop": "^1.1",
diff --git a/conf/config.neon b/conf/config.neon
@@ -78,6 +78,8 @@ parameters:
 		- '#^Hoa\\#'
 		- '#^DateTime(?:Interface|Immutable)?$#'
 		- '#^Soap(?:Client|Var|Server|Fault|Param|Header)$#'
+		- '#^Serializable$#'
+		- '#^XMLReader#'
 	dynamicConstantNames:
 		- ICONV_IMPL
 		- LIBXML_VERSION
diff --git a/src/Reflection/BetterReflection/BetterReflectionProvider.php b/src/Reflection/BetterReflection/BetterReflectionProvider.php
@@ -36,6 +36,8 @@
 class BetterReflectionProvider implements ReflectionProvider
 {
 
+	private ReflectionProvider\ReflectionProviderProvider $reflectionProviderProvider;
+
 	private \PHPStan\DependencyInjection\Reflection\ClassReflectionExtensionRegistryProvider $classReflectionExtensionRegistryProvider;
 
 	private \Roave\BetterReflection\Reflector\ClassReflector $classReflector;
@@ -72,6 +74,7 @@ class BetterReflectionProvider implements ReflectionProvider
 	private static array $anonymousClasses = [];
 
 	public function __construct(
+		ReflectionProvider\ReflectionProviderProvider $reflectionProviderProvider,
 		ClassReflectionExtensionRegistryProvider $classReflectionExtensionRegistryProvider,
 		ClassReflector $classReflector,
 		FileTypeMapper $fileTypeMapper,
@@ -87,6 +90,7 @@ public function __construct(
 		ConstantReflector $constantReflector
 	)
 	{
+		$this->reflectionProviderProvider = $reflectionProviderProvider;
 		$this->classReflectionExtensionRegistryProvider = $classReflectionExtensionRegistryProvider;
 		$this->classReflector = $classReflector;
 		$this->fileTypeMapper = $fileTypeMapper;
@@ -137,7 +141,7 @@ public function getClass(string $className): ClassReflection
 		}
 
 		$classReflection = new ClassReflection(
-			$this,
+			$this->reflectionProviderProvider->getReflectionProvider(),
 			$this->fileTypeMapper,
 			$this->classReflectionExtensionRegistryProvider->getRegistry()->getPropertiesClassReflectionExtensions(),
 			$this->classReflectionExtensionRegistryProvider->getRegistry()->getMethodsClassReflectionExtensions(),
@@ -203,7 +207,7 @@ public function getAnonymousClassReflection(\PhpParser\Node\Stmt\Class_ $classNo
 		);
 
 		self::$anonymousClasses[$className] = new ClassReflection(
-			$this,
+			$this->reflectionProviderProvider->getReflectionProvider(),
 			$this->fileTypeMapper,
 			$this->classReflectionExtensionRegistryProvider->getRegistry()->getPropertiesClassReflectionExtensions(),
 			$this->classReflectionExtensionRegistryProvider->getRegistry()->getMethodsClassReflectionExtensions(),
diff --git a/src/Reflection/ClassReflection.php b/src/Reflection/ClassReflection.php
@@ -481,7 +481,11 @@ public function isSubclassOf(string $className): bool
 			return $this->subclasses[$className] = false;
 		}
 
-		return $this->subclasses[$className] = $this->reflection->isSubclassOf($className);
+		try {
+			return $this->subclasses[$className] = $this->reflection->isSubclassOf($className);
+		} catch (\ReflectionException $e) {
+			return $this->subclasses[$className] = false;
+		}
 	}
 
 	/**
diff --git a/src/Reflection/PhpDefect/PhpDefectClassReflectionExtension.php b/src/Reflection/PhpDefect/PhpDefectClassReflectionExtension.php
@@ -148,22 +148,6 @@ class PhpDefectClassReflectionExtension implements PropertiesClassReflectionExte
 			'exceptions_enabled' => 'int',
 			'info' => 'array',
 		],
-		'XMLReader' => [
-			'attributeCount' => 'int',
-			'baseURI' => 'string',
-			'depth' => 'int',
-			'hasAttributes' => 'bool',
-			'hasValue' => 'bool',
-			'isDefault' => 'bool',
-			'isEmptyElement' => 'bool',
-			'localName' => 'string',
-			'name' => 'string',
-			'namespaceURI' => 'string',
-			'nodeType' => 'int',
-			'prefix' => 'string',
-			'value' => 'string',
-			'xmlLang' => 'string',
-		],
 		'ZipArchive' => [
 			'status' => 'int',
 			'statusSys' => 'int',
diff --git a/src/Reflection/Runtime/RuntimeReflectionProvider.php b/src/Reflection/Runtime/RuntimeReflectionProvider.php
@@ -26,6 +26,8 @@
 class RuntimeReflectionProvider implements ReflectionProvider
 {
 
+	private ReflectionProvider\ReflectionProviderProvider $reflectionProviderProvider;
+
 	private ClassReflectionExtensionRegistryProvider $classReflectionExtensionRegistryProvider;
 
 	/** @var \PHPStan\Reflection\ClassReflection[] */
@@ -62,6 +64,7 @@ class RuntimeReflectionProvider implements ReflectionProvider
 	private static array $anonymousClasses = [];
 
 	public function __construct(
+		ReflectionProvider\ReflectionProviderProvider $reflectionProviderProvider,
 		ClassReflectionExtensionRegistryProvider $classReflectionExtensionRegistryProvider,
 		FunctionReflectionFactory $functionReflectionFactory,
 		FileTypeMapper $fileTypeMapper,
@@ -74,6 +77,7 @@ public function __construct(
 		StubPhpDocProvider $stubPhpDocProvider
 	)
 	{
+		$this->reflectionProviderProvider = $reflectionProviderProvider;
 		$this->classReflectionExtensionRegistryProvider = $classReflectionExtensionRegistryProvider;
 		$this->functionReflectionFactory = $functionReflectionFactory;
 		$this->fileTypeMapper = $fileTypeMapper;
@@ -194,7 +198,7 @@ private function getClassFromReflection(\ReflectionClass $reflectionClass, strin
 		$className = $reflectionClass->getName();
 		if (!isset($this->classReflections[$className])) {
 			$classReflection = new ClassReflection(
-				$this,
+				$this->reflectionProviderProvider->getReflectionProvider(),
 				$this->fileTypeMapper,
 				$this->classReflectionExtensionRegistryProvider->getRegistry()->getPropertiesClassReflectionExtensions(),
 				$this->classReflectionExtensionRegistryProvider->getRegistry()->getMethodsClassReflectionExtensions(),
diff --git a/src/Testing/TestCase.php b/src/Testing/TestCase.php
@@ -206,6 +206,7 @@ private function createRuntimeReflectionProvider(ReflectionProvider $actualRefle
 		);
 		$reflectionProvider = new ClassBlacklistReflectionProvider(
 			new RuntimeReflectionProvider(
+				$setterReflectionProviderProvider,
 				$classReflectionExtensionRegistryProvider,
 				$functionReflectionFactory,
 				$fileTypeMapper,
@@ -223,6 +224,8 @@ private function createRuntimeReflectionProvider(ReflectionProvider $actualRefle
 				'#^Hoa\\\\#',
 				'#^DateTime(?:Interface|Immutable)?$#',
 				'#^Soap(?:Client|Var|Server|Fault|Param|Header)$#',
+				'#^Serializable$#',
+				'#^XMLReader#',
 			]
 		);
 		$this->setUpReflectionProvider(
@@ -362,6 +365,7 @@ private function createStaticReflectionProvider(): ReflectionProvider
 		$classReflectionExtensionRegistryProvider = $this->getClassReflectionExtensionRegistryProvider();
 
 		$reflectionProvider = new BetterReflectionProvider(
+			$setterReflectionProviderProvider,
 			$classReflectionExtensionRegistryProvider,
 			$classReflector,
 			$fileTypeMapper,
diff --git a/stubs/iterable.stub b/stubs/iterable.stub
@@ -94,7 +94,7 @@ interface SeekableIterator extends Iterator
  * @implements SeekableIterator<TKey, TValue>
  * @implements ArrayAccess<TKey, TValue>
  */
-class ArrayIterator implements SeekableIterator, ArrayAccess, Countable, Serializable
+class ArrayIterator implements SeekableIterator, ArrayAccess, Countable
 {
 
 	/**
diff --git a/tests/PHPStan/Broker/BrokerTest.php b/tests/PHPStan/Broker/BrokerTest.php
@@ -42,6 +42,7 @@ protected function setUp(): void
 
 		$setterReflectionProviderProvider = new SetterReflectionProviderProvider();
 		$reflectionProvider = new RuntimeReflectionProvider(
+			$setterReflectionProviderProvider,
 			$classReflectionExtensionRegistryProvider,
 			$this->createMock(FunctionReflectionFactory::class),
 			new FileTypeMapper($setterReflectionProviderProvider, $this->getParser(), $phpDocStringResolver, $phpDocNodeResolver, $this->createMock(Cache::class), $anonymousClassNameHelper),
diff --git a/tests/PHPStan/Reflection/PhpDefect/PhpDefectClassReflectionExtensionTest.php b/tests/PHPStan/Reflection/PhpDefect/PhpDefectClassReflectionExtensionTest.php
@@ -5,7 +5,6 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Broker\Broker;
 use PHPStan\Type\VerbosityLevel;
-use XMLReader;
 use ZipArchive;
 
 class PhpDefectClassReflectionExtensionTest extends \PHPStan\Testing\TestCase
@@ -27,7 +26,6 @@ class PhpDefectClassReflectionExtensionTest extends \PHPStan\Testing\TestCase
 	 * @dataProvider dataDomTextProperties
 	 * @dataProvider dataDomProcessingInstructionProperties
 	 * @dataProvider dataDomXPathProperties
-	 * @dataProvider dataXmlReaderProperties
 	 * @dataProvider dataZipArchiveProperties
 	 * @dataProvider dataLibXMLErrorProperties
 	 * @param string $className
@@ -550,32 +548,6 @@ public function dataDomXPathProperties(): array
 		];
 	}
 
-	public function dataXmlReaderProperties(): array
-	{
-		return [
-			[
-				XMLReader::class,
-				XMLReader::class,
-				[
-					'attributeCount' => 'int',
-					'baseURI' => 'string',
-					'depth' => 'int',
-					'hasAttributes' => 'bool',
-					'hasValue' => 'bool',
-					'isDefault' => 'bool',
-					'isEmptyElement' => 'bool',
-					'localName' => 'string',
-					'name' => 'string',
-					'namespaceURI' => 'string',
-					'nodeType' => 'int',
-					'prefix' => 'string',
-					'value' => 'string',
-					'xmlLang' => 'string',
-				],
-			],
-		];
-	}
-
 	public function dataZipArchiveProperties(): array
 	{
 		if (!class_exists('ZipArchive')) {
diff --git a/tests/PHPStan/Rules/Methods/data/missing-method-parameter-typehint.php b/tests/PHPStan/Rules/Methods/data/missing-method-parameter-typehint.php
@@ -158,3 +158,18 @@ public function doFoo($obj)
 	}
 
 }
+
+class SerializableImpl implements \Serializable
+{
+
+	public function serialize(): string
+	{
+		return serialize([]);
+	}
+
+	public function unserialize($serialized): void
+	{
+
+	}
+
+}

Original file line number	Diff line number	Diff line change
`@@ -481,7 +481,11 @@ public function isSubclassOf(string $className): bool`
`481`	`481`	`return $this->subclasses[$className] = false;`
`482`	`482`	`}`
`483`	`483`
`484`		`- return $this->subclasses[$className] = $this->reflection->isSubclassOf($className);`
	`484`	`+ try {`
	`485`	`+ return $this->subclasses[$className] = $this->reflection->isSubclassOf($className);`
	`486`	`+ } catch (\ReflectionException $e) {`
	`487`	`+ return $this->subclasses[$className] = false;`
	`488`	`+ }`
`485`	`489`	`}`
`486`	`490`
`487`	`491`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ interface SeekableIterator extends Iterator`
`94`	`94`	`* @implements SeekableIterator<TKey, TValue>`
`95`	`95`	`* @implements ArrayAccess<TKey, TValue>`
`96`	`96`	`*/`
`97`		`-class ArrayIterator implements SeekableIterator, ArrayAccess, Countable, Serializable`
	`97`	`+class ArrayIterator implements SeekableIterator, ArrayAccess, Countable`
`98`	`98`	`{`
`99`	`99`
`100`	`100`	`/**`