Skip to content

Add support for internal classes that overload offset access #3725

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

Merged
ondrejmirtes merged 7 commits into from
Dec 17, 2024
Merged

Add support for internal classes that overload offset access #3725

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fcdfa63
Add support for internal classes that overload offset access
Girgias Dec 11, 2024
bff963c
Add tests
Girgias Dec 12, 2024
21881f4
Split tests for 8.4 and below
Girgias Dec 12, 2024
7c60acf
add version constraints
Girgias Dec 12, 2024
44d39ff
use PHP_VERSION_ID instead
Girgias Dec 14, 2024
0669763
Update tests/PHPStan/Rules/Arrays/NonexistentOffsetInArrayDimFetchRul…
ondrejmirtes Dec 17, 2024
f50ed86
Update tests/PHPStan/Rules/Arrays/NonexistentOffsetInArrayDimFetchRul…
ondrejmirtes Dec 17, 2024
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
14 changes: 13 additions & 1 deletion src/Type/ObjectType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,19 @@ class ObjectType implements TypeWithClassName, SubtractableType
use UndecidedComparisonTypeTrait;
use NonGeneralizableTypeTrait;

private const EXTRA_OFFSET_CLASSES = ['SimpleXMLElement', 'DOMNodeList', 'Threaded'];
private const EXTRA_OFFSET_CLASSES = [
'DOMNamedNodeMap', // Only read and existence
'Dom\NamedNodeMap', // Only read and existence
'DOMNodeList', // Only read and existence
'Dom\NodeList', // Only read and existence
'Dom\HTMLCollection', // Only read and existence
'Dom\DtdNamedNodeMap', // Only read and existence
'PDORow', // Only read and existence
'ResourceBundle', // Only read
'FFI\CData', // Very funky and weird
'SimpleXMLElement',
'Threaded',
];

private ?Type $subtractedType;

Expand Down
20 changes: 20 additions & 0 deletions tests/PHPStan/Rules/Arrays/NonexistentOffsetInArrayDimFetchRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -898,4 +898,24 @@ public function testBug2634(): void
$this->analyse([__DIR__ . '/data/bug-2634.php'], []);
}

public function testInternalClassesWithOverloadedOffsetAccess(): void
{
$this->analyse([__DIR__ . '/data/internal-classes-overload-offset-access.php'], []);
}

public function testInternalClassesWithOverloadedOffsetAccess84(): void
{
$this->analyse([__DIR__ . '/data/internal-classes-overload-offset-access-php84.php'], []);
}

public function testInternalClassesWithOverloadedOffsetAccessInvalid(): void
{
$this->analyse([__DIR__ . '/data/internal-classes-overload-offset-access-invalid.php'], []);
}

public function testInternalClassesWithOverloadedOffsetAccessInvalid84(): void
{
$this->analyse([__DIR__ . '/data/internal-classes-overload-offset-access-invalid-php84.php'], []);
}

}
91 changes: 91 additions & 0 deletions tests/PHPStan/Rules/Arrays/data/internal-classes-overload-offset-access-invalid-php84.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<?php // lint >= 8.4
/**
* All of these offset accesses are invalid
* ++ and -- are also disallowed in general are they operate "by ref"
Copy link
Contributor

@staabm staabm Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* ++ and -- are also disallowed in general are they operate "by ref"
* ++ and -- are also disallowed in general as they operate "by ref"

*/
namespace InternalClassesOverloadOffsetAccessInvalid\Php84;

function test1(\DOMNamedNodeMap $v): void
{
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
}

function test2(\Dom\NamedNodeMap $v): void
{
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
}

function test3(\DOMNodeList $v): void
{
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
}

function test4(\Dom\NodeList $v): void
{
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
}

function test5(\Dom\HTMLCollection $v): void
{
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
}

function test6(\Dom\DtdNamedNodeMap $v): void
{
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
}

function test7(\PDORow $v): void
{
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
}

function test8(\ResourceBundle $v): void
{
if ($v[0]) {
var_dump($v[0]);
}
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
var_dump($v['name']);
var_dump($v[0]);
}
52 changes: 52 additions & 0 deletions tests/PHPStan/Rules/Arrays/data/internal-classes-overload-offset-access-invalid.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php
/**
* All of these offset accesses are invalid
* ++ and -- are also disallowed in general are they operate "by ref"
Copy link
Contributor

@staabm staabm Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* ++ and -- are also disallowed in general are they operate "by ref"
* ++ and -- are also disallowed in general as they operate "by ref"

*/
namespace InternalClassesOverloadOffsetAccessInvalid;

function test1(\DOMNamedNodeMap $v): void
{
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
}

function test3(\DOMNodeList $v): void
{
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
}

function test7(\PDORow $v): void
{
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
}

function test8(\ResourceBundle $v): void
{
if ($v[0]) {
var_dump($v[0]);
}
$v[] = 'append';
$v[0] = 'update';
$v[0] .= ' and again';
$r1 = &$v[0];
unset($v[0]);
var_dump($r1);
var_dump($v['name']);
var_dump($v[0]);
}

74 changes: 74 additions & 0 deletions tests/PHPStan/Rules/Arrays/data/internal-classes-overload-offset-access-php84.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<?php // lint >= 8.4
Copy link
Contributor Author

@Girgias Girgias Dec 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't seem to be working? Not sure why however.

Copy link
Member

@ondrejmirtes ondrejmirtes Dec 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This only works in /nsrt/. But here you're in a rule test. Which means you need to call $this->markTestSkipped() in the test based on PHP_VERSION_ID. There are many existing tests that do this.

Copy link
Contributor

@thg2k thg2k Dec 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This only works in /nsrt/. But here you're in a rule test. Which means you need to call $this->markTestSkipped() in the test based on PHP_VERSION_ID. There are many existing tests that do this.

Remember I tried to introduce a new annotation syntax that would allow us to use the same skip system for all data files? (main gotcha was data files that required ranges and additional conditions for skipping). The current system is cumbersome and unintuitive. Would you like to revisit my idea? I can provide a sample PR on which to discuss it.

Copy link
Member

@ondrejmirtes ondrejmirtes Dec 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current system works very well in my opinion :)

One day we might be able to test the rules in a similar way we test inferred types (by discovering and filtering files in a directory) but today is not that day.


namespace InternalClassesOverloadOffsetAccess\Php84;

function test1(\DOMNamedNodeMap $v): void
{
if ($v['attribute_name']) {
var_dump($v['attribute_name']);
}
if ($v[0]) {
var_dump($v[0]);
}
}

function test2(\Dom\NamedNodeMap $v): void
{
if ($v['attribute_name']) {
var_dump($v['attribute_name']);
}
if ($v[0]) {
var_dump($v[0]);
}
}

function test3(\DOMNodeList $v): void
{
if ($v[0]) {
var_dump($v[0]);
}
}

function test4(\Dom\NodeList $v): void
{
//var_dump($v['attribute_name']);
if ($v[0]) {
var_dump($v[0]);
}
}

function test5(\Dom\HTMLCollection $v): void
{
if ($v['name']) {
var_dump($v['name']);
}
if ($v[0]) {
var_dump($v[0]);
}
}

function test6(\Dom\DtdNamedNodeMap $v): void
{
if ($v['name']) {
var_dump($v['name']);
}
if ($v[0]) {
var_dump($v[0]);
}
}

function test7(\PDORow $v): void
{
if ($v['name']) {
var_dump($v['name']);
}
if ($v[0]) {
var_dump($v[0]);
}
}

function test8(\ResourceBundle $v): void
{
var_dump($v['name']);
var_dump($v[0]);
}
37 changes: 37 additions & 0 deletions tests/PHPStan/Rules/Arrays/data/internal-classes-overload-offset-access.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php

namespace InternalClassesOverloadOffsetAccess;

function test1(\DOMNamedNodeMap $v): void
{
if ($v['attribute_name']) {
var_dump($v['attribute_name']);
}
if ($v[0]) {
var_dump($v[0]);
}
}

function test3(\DOMNodeList $v): void
{
if ($v[0]) {
var_dump($v[0]);
}
}

function test7(\PDORow $v): void
{
if ($v['name']) {
var_dump($v['name']);
}
if ($v[0]) {
var_dump($v[0]);
}
}

function test8(\ResourceBundle $v): void
{
var_dump($v['name']);
var_dump($v[0]);
}

Loading