array_column should not extract non-public properties from objects

Fixes phpstan/phpstan#13573

Author: janedbal

src/Type/Php/ArrayColumnFunctionReturnTypeExtension.php

@@ -79,11 +79,11 @@ private function handleAnyArray(Type $arrayType, Type $columnType, ?Type $indexT
 
 		if ($indexType !== null) {
 			$type = $this->getOffsetOrProperty($iterableValueType, $indexType, $scope, false);
-			if ($type !== null) {
+			if ($type !== null && !$type instanceof NeverType) {
 				$returnKeyType = $type;
 			} else {
 				$type = $this->getOffsetOrProperty($iterableValueType, $indexType, $scope, true);
-				if ($type !== null) {
+				if ($type !== null && !$type instanceof NeverType) {
 					$returnKeyType = TypeCombinator::union($type, new IntegerType());
 				} else {
 					$returnKeyType = new IntegerType();
@@ -120,11 +120,11 @@ private function handleConstantArray(ConstantArrayType $arrayType, Type $columnT
 
 			if ($indexType !== null) {
 				$type = $this->getOffsetOrProperty($iterableValueType, $indexType, $scope, false);
-				if ($type !== null) {
+				if ($type !== null && !$type instanceof NeverType) {
 					$keyType = $type;
 				} else {
 					$type = $this->getOffsetOrProperty($iterableValueType, $indexType, $scope, true);
-					if ($type !== null) {
+					if ($type !== null && !$type instanceof NeverType) {
 						$keyType = TypeCombinator::union($type, new IntegerType());
 					} else {
 						$keyType = null;
@@ -171,7 +171,12 @@ private function getOffsetOrProperty(Type $type, Type $offsetOrProperty, Scope $
 					continue;
 				}
 
-				$returnTypes[] = $type->getProperty($propertyName, $scope)->getReadableType();
+				$property = $type->getProperty($propertyName, $scope);
+				if (!$property->isPublic()) {
+					continue;
+				}
+
+				$returnTypes[] = $property->getReadableType();
 			}
 		}
 

tests/PHPStan/Analyser/nsrt/array-column-php82.php

@@ -218,3 +218,53 @@ public function doFoo(array $a): void
 	}
 
 }
+
+class ObjectWithVisibility
+{
+	public int $pub = 1;
+	protected int $prot = 2;
+	private int $priv = 3;
+}
+
+class ArrayColumnVisibilityTest
+{
+
+	/** @param array<int, ObjectWithVisibility> $objects */
+	public function testNonPublicProperties(array $objects): void
+	{
+		assertType('list<int>', array_column($objects, 'pub'));
+		assertType('array{}', array_column($objects, 'prot'));
+		assertType('array{}', array_column($objects, 'priv'));
+	}
+
+	/** @param array{ObjectWithVisibility} $objects */
+	public function testNonPublicPropertiesConstant(array $objects): void
+	{
+		assertType('array{int}', array_column($objects, 'pub'));
+		assertType('array{}', array_column($objects, 'prot'));
+		assertType('array{}', array_column($objects, 'priv'));
+	}
+
+	/** @param array<int, ObjectWithVisibility> $objects */
+	public function testNonPublicAsIndex(array $objects): void
+	{
+		assertType('array<int, int>', array_column($objects, 'pub', 'pub'));
+		assertType('array<int, int>', array_column($objects, 'pub', 'priv'));
+	}
+
+}
+
+class ArrayColumnVisibilityFromInsideTest
+{
+
+	public int $pub = 1;
+	private int $priv = 2;
+
+	/** @param list<self> $objects */
+	public function testFromInside(array $objects): void
+	{
+		assertType('list<int>', array_column($objects, 'pub'));
+		assertType('array{}', array_column($objects, 'priv'));
+	}
+
+}

tests/PHPStan/Analyser/nsrt/array-column.php

@@ -232,3 +232,53 @@ public function doFoo(array $a): void
 	}
 
 }
+
+class ObjectWithVisibility
+{
+	public int $pub = 1;
+	protected int $prot = 2;
+	private int $priv = 3;
+}
+
+class ArrayColumnVisibilityTest
+{
+
+	/** @param array<int, ObjectWithVisibility> $objects */
+	public function testNonPublicProperties(array $objects): void
+	{
+		assertType('list<int>', array_column($objects, 'pub'));
+		assertType('array{}', array_column($objects, 'prot'));
+		assertType('array{}', array_column($objects, 'priv'));
+	}
+
+	/** @param array{ObjectWithVisibility} $objects */
+	public function testNonPublicPropertiesConstant(array $objects): void
+	{
+		assertType('array{int}', array_column($objects, 'pub'));
+		assertType('array{}', array_column($objects, 'prot'));
+		assertType('array{}', array_column($objects, 'priv'));
+	}
+
+	/** @param array<int, ObjectWithVisibility> $objects */
+	public function testNonPublicAsIndex(array $objects): void
+	{
+		assertType('array<int, int>', array_column($objects, 'pub', 'pub'));
+		assertType('array<int, int>', array_column($objects, 'pub', 'priv'));
+	}
+
+}
+
+class ArrayColumnVisibilityFromInsideTest
+{
+
+	public int $pub = 1;
+	private int $priv = 2;
+
+	/** @param list<self> $objects */
+	public function testFromInside(array $objects): void
+	{
+		assertType('list<int>', array_column($objects, 'pub'));
+		assertType('array{}', array_column($objects, 'priv'));
+	}
+
+}