Skip to content

array_column should not extract non-public properties from objects #5210

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

Open
janedbal wants to merge 3 commits into
base: 2.1.x
Choose a base branch
from
+332 −2
Open

array_column should not extract non-public properties from objects #5210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
acf44c2
array_column should not extract non-accessible properties from objects
janedbal Mar 12, 2026
40cce7a
Account for non-final classes: child can override property visibility
janedbal Mar 16, 2026
4538d2f
Use isFinalByKeyword instead of isFinal
janedbal Mar 16, 2026
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
27 changes: 25 additions & 2 deletions src/Type/Php/ArrayColumnHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ public function getReturnIndexType(Type $arrayType, Type $indexType, Scope $scop
$iterableValueType = $arrayType->getIterableValueType();

[$type, $certainty] = $this->getOffsetOrProperty($iterableValueType, $indexType, $scope);
if ($type instanceof NeverType) {
return new IntegerType();
}
if ($certainty->yes()) {
return $type;
}
Expand Down Expand Up @@ -98,7 +101,9 @@ public function handleConstantArray(ConstantArrayType $arrayType, Type $columnTy

if (!$indexType->isNull()->yes()) {
[$type, $certainty] = $this->getOffsetOrProperty($iterableValueType, $indexType, $scope);
if ($certainty->yes()) {
if ($type instanceof NeverType) {
$keyType = null;
} elseif ($certainty->yes()) {
$keyType = $type;
} else {
$keyType = TypeCombinator::union($type, new IntegerType());
Expand Down Expand Up @@ -147,7 +152,25 @@ private function getOffsetOrProperty(Type $type, Type $offsetOrProperty, Scope $
continue;
}

$returnTypes[] = $type->getInstanceProperty($propertyName, $scope)->getReadableType();
$property = $type->getInstanceProperty($propertyName, $scope);
if (!$scope->canReadProperty($property)) {
foreach ($type->getObjectClassReflections() as $classReflection) {
if ($classReflection->hasMethod('__isset') && $classReflection->hasMethod('__get')) {
return [new MixedType(), TrinaryLogic::createMaybe()];
}

if (!$classReflection->isFinalByKeyword()) {
if ($property->isPrivate()) {
return [new MixedType(), TrinaryLogic::createMaybe()];
}

return [$property->getReadableType(), TrinaryLogic::createMaybe()];
}
}
continue;
}

$returnTypes[] = $property->getReadableType();
}
}

Expand Down
160 changes: 160 additions & 0 deletions tests/PHPStan/Analyser/nsrt/array-column-php82.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,3 +237,163 @@ public function doFoo(array $a): void
}

}

class NonFinalObjectWithVisibility
{
public int $pub = 1;
protected int $prot = 2;
private int $priv = 3;
}

final class FinalObjectWithVisibility
{
public int $pub = 1;
protected int $prot = 2;
private int $priv = 3;
}

class ArrayColumnVisibilityNonFinalTest
{

/** @param array<int, NonFinalObjectWithVisibility> $objects */
public function testNonFinal(array $objects): void
{
assertType('list<int>', array_column($objects, 'pub'));
assertType('list<int>', array_column($objects, 'prot'));
assertType('list', array_column($objects, 'priv'));
}

/** @param array{NonFinalObjectWithVisibility} $objects */
public function testNonFinalConstant(array $objects): void
{
assertType('array{int}', array_column($objects, 'pub'));
assertType('list<int>', array_column($objects, 'prot'));
assertType('list', array_column($objects, 'priv'));
}

}

class ArrayColumnVisibilityFinalTest
{

/** @param array<int, FinalObjectWithVisibility> $objects */
public function testFinal(array $objects): void
{
assertType('list<int>', array_column($objects, 'pub'));
assertType('array{}', array_column($objects, 'prot'));
assertType('array{}', array_column($objects, 'priv'));
}

/** @param array{FinalObjectWithVisibility} $objects */
public function testFinalConstant(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, FinalObjectWithVisibility> $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 ArrayColumnVisibilityImplicitFinalTest
{

public function testNewExpression(): void
{
$objects = [new NonFinalObjectWithVisibility()];
assertType('array{int}', array_column($objects, 'pub'));
assertType('array{}', array_column($objects, 'prot'));
assertType('array{}', array_column($objects, '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('list<int>', array_column($objects, 'priv'));
}

}

class ArrayColumnVisibilityFromChildTest extends NonFinalObjectWithVisibility
{

/** @param list<NonFinalObjectWithVisibility> $objects */
public function testFromChild(array $objects): void
{
assertType('list<int>', array_column($objects, 'pub'));
assertType('list<int>', array_column($objects, 'prot'));
assertType('list', array_column($objects, 'priv'));
}

}

final class ObjectWithIssetOnly
{
private int $priv = 2;

public function __isset(string $name): bool
{
return true;
}
}

class ArrayColumnVisibilityWithIssetOnlyTest
{

/** @param array<int, ObjectWithIssetOnly> $objects */
public function testWithIssetOnly(array $objects): void
{
assertType('array{}', array_column($objects, 'priv'));
}

}

class ObjectWithIsset
{
public int $pub = 1;
private int $priv = 2;

public function __isset(string $name): bool
{
return true;
}

public function __get(string $name): mixed
{
return $this->$name;
}
}

class ArrayColumnVisibilityWithIssetTest
{

/** @param array<int, ObjectWithIsset> $objects */
public function testWithIsset(array $objects): void
{
assertType('list<int>', array_column($objects, 'pub'));
assertType('list', array_column($objects, 'priv'));
}

/** @param array{ObjectWithIsset} $objects */
public function testWithIssetConstant(array $objects): void
{
assertType('array{int}', array_column($objects, 'pub'));
assertType('list', array_column($objects, 'priv'));
}

}
147 changes: 147 additions & 0 deletions tests/PHPStan/Analyser/nsrt/array-column.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,3 +252,150 @@ public function doFoo(array $a): void
}

}

class NonFinalObjectWithVisibility
{
public int $pub = 1;
protected int $prot = 2;
private int $priv = 3;
}

final class FinalObjectWithVisibility
{
public int $pub = 1;
protected int $prot = 2;
private int $priv = 3;
}

class ArrayColumnVisibilityNonFinalTest
{

/** @param array<int, NonFinalObjectWithVisibility> $objects */
public function testNonFinal(array $objects): void
{
assertType('list<int>', array_column($objects, 'pub'));
assertType('list<int>', array_column($objects, 'prot'));
assertType('list', array_column($objects, 'priv'));
}

/** @param array{NonFinalObjectWithVisibility} $objects */
public function testNonFinalConstant(array $objects): void
{
assertType('array{int}', array_column($objects, 'pub'));
assertType('list<int>', array_column($objects, 'prot'));
assertType('list', array_column($objects, 'priv'));
}

}

class ArrayColumnVisibilityFinalTest
{

/** @param array<int, FinalObjectWithVisibility> $objects */
public function testFinal(array $objects): void
{
assertType('list<int>', array_column($objects, 'pub'));
assertType('array{}', array_column($objects, 'prot'));
assertType('array{}', array_column($objects, 'priv'));
}

/** @param array{FinalObjectWithVisibility} $objects */
public function testFinalConstant(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, FinalObjectWithVisibility> $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('list<int>', array_column($objects, 'priv'));
}

}

class ArrayColumnVisibilityFromChildTest extends NonFinalObjectWithVisibility
{

/** @param list<NonFinalObjectWithVisibility> $objects */
public function testFromChild(array $objects): void
{
assertType('list<int>', array_column($objects, 'pub'));
assertType('list<int>', array_column($objects, 'prot'));
assertType('list', array_column($objects, 'priv'));
}

}

final class ObjectWithIssetOnly
{
private int $priv = 2;

public function __isset(string $name): bool
{
return true;
}
}

class ArrayColumnVisibilityWithIssetOnlyTest
{

/** @param array<int, ObjectWithIssetOnly> $objects */
public function testWithIssetOnly(array $objects): void
{
assertType('array{}', array_column($objects, 'priv'));
}

}

class ObjectWithIsset
{
public int $pub = 1;
private int $priv = 2;

public function __isset(string $name): bool
{
return true;
}

public function __get(string $name): mixed
{
return $this->$name;
}
}

class ArrayColumnVisibilityWithIssetTest
{

/** @param array<int, ObjectWithIsset> $objects */
public function testWithIsset(array $objects): void
{
assertType('list<int>', array_column($objects, 'pub'));
assertType('list', array_column($objects, 'priv'));
}

/** @param array{ObjectWithIsset} $objects */
public function testWithIssetConstant(array $objects): void
{
assertType('array{int}', array_column($objects, 'pub'));
assertType('list', array_column($objects, 'priv'));
}

}
Loading