Skip to content

Add param out for propertyAccessor #386

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.

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
merged 2 commits into from
Mar 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"require": {
"php": "^7.2 || ^8.0",
"ext-simplexml": "*",
"phpstan/phpstan": "^1.10.36"
"phpstan/phpstan": "^1.10.62"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

For conditional phpstan-param-out

},
"conflict": {
"symfony/framework-bundle": "<3.0"
Expand Down
6 changes: 6 additions & 0 deletions extension.neon
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,12 @@ parameters:
- stubs/Symfony/Component/OptionsResolver/Exception/InvalidOptionsException.stub
- stubs/Symfony/Component/OptionsResolver/Options.stub
- stubs/Symfony/Component/Process/Process.stub
- stubs/Symfony/Component/PropertyAccess/Exception/AccessException.stub
- stubs/Symfony/Component/PropertyAccess/Exception/ExceptionInterface.stub
- stubs/Symfony/Component/PropertyAccess/Exception/InvalidArgumentException.stub
- stubs/Symfony/Component/PropertyAccess/Exception/RuntimeException.stub
- stubs/Symfony/Component/PropertyAccess/Exception/UnexpectedTypeException.stub
- stubs/Symfony/Component/PropertyAccess/PropertyAccessorInterface.stub
- stubs/Symfony/Component/PropertyAccess/PropertyPathInterface.stub
- stubs/Symfony/Component/Security/Acl/Model/AclInterface.stub
- stubs/Symfony/Component/Security/Acl/Model/EntryInterface.stub
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

namespace Symfony\Component\PropertyAccess\Exception;

class AccessException extends RuntimeException
{
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

namespace Symfony\Component\PropertyAccess\Exception;

interface ExceptionInterface extends \Throwable
{
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

namespace Symfony\Component\PropertyAccess\Exception;

class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
{
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

namespace Symfony\Component\PropertyAccess\Exception;

class RuntimeException extends \RuntimeException implements ExceptionInterface
{
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

namespace Symfony\Component\PropertyAccess\Exception;

class UnexpectedTypeException extends RuntimeException
{
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?php

namespace Symfony\Component\PropertyAccess;

interface PropertyAccessorInterface
{

/**
* @phpstan-template T of object|array<mixed>
* @phpstan-param T &$objectOrArray
* @phpstan-param-out ($objectOrArray is object ? T : array<mixed>) $objectOrArray
Copy link
Contributor

@herndlm herndlm Mar 18, 2024

Choose a reason for hiding this comment

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

hi, just for my understanding - this could be simply @phpstan-param-out T $objectOrArray as well, right?

I had a local stub with something like that and got an error when updating because of this PR -> could remove my local stub -> thx! :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@phpstan-template T of object|array<mixed>
@phpstan-param T &$objectOrArray
@phpstan-param-out T $objectOrArray

doesn't give the same beahvior

It fails

$array = [1 => 'ea'];
$propertyAccessor->setValue($array, 'foo', 'bar');
assertType('array', $array);

You'll get array{1: 'ea'} instead, which is wrong.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah OK, makes sense. Thx!

* @phpstan-param string|PropertyPathInterface $propertyPath
* @phpstan-param mixed $value
*
* @return void
*
* @throws Exception\InvalidArgumentException If the property path is invalid
* @throws Exception\AccessException If a property/index does not exist or is not public
* @throws Exception\UnexpectedTypeException If a value within the path is neither object nor array
*/
public function setValue(&$objectOrArray, $propertyPath, $value);

}
1 change: 1 addition & 0 deletions tests/Type/Symfony/ExtensionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ public function dataFileAsserts(): iterable
yield from $this->gatherAssertTypes(__DIR__ . '/data/ExampleOptionCommand.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/ExampleOptionLazyCommand.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/kernel_interface.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/property_accessor.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/request_get_content.php');

$ref = new ReflectionMethod(Request::class, 'getSession');
Expand Down
13 changes: 13 additions & 0 deletions tests/Type/Symfony/data/property_accessor.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php declare(strict_types = 1);

use function PHPStan\Testing\assertType;

$propertyAccessor = new \Symfony\Component\PropertyAccess\PropertyAccessor();

$array = [1 => 'ea'];
$propertyAccessor->setValue($array, 'foo', 'bar');
assertType('array', $array);

$object = new \stdClass();
$propertyAccessor->setValue($object, 'foo', 'bar');
assertType('stdClass', $object);