minor #60860 Move property accessor phpdoc to interface (VincentLanglet)

nicolas-grekas · nicolas-grekas · commit a593f146556f · 2025-06-23T08:52:32.000+02:00
This PR was merged into the 7.2 branch. Discussion ---------- Move property accessor phpdoc to interface | Q | A | ------------- | --- | Branch? | 7.2 | Bug fix? | no | New feature? | no  | Deprecations? | no  | Issues | Fix #...  | License | MIT This gives the same help for static analyser than #60374 but for the Interface. I targeted the 7.2 branch since it's the one the phpdoc was introduced. I copy the explanation: > This pull request was made to help static code analyzers understand that when calling PropertyAccessor::setValue, this will > not change the type of the passed $objectOrArray. > At the moment static analysis will point out that the value of $objectOrArray can be any object or an array after calling the > setValue method, which is of course not the case. > The solution comes directly from this closed PHPStan issue: phpstan/phpstan#12399 > (Other tools like Psalm also support `@param`-out) According to the Interface description this behavior shouldn't be restricted to PropertyAccessor but should be enforced/described in the interface too. Commits ------- 2e40d28 Move property accessor phpdoc to interface
diff --git a/src/Symfony/Component/PropertyAccess/PropertyAccessor.php b/src/Symfony/Component/PropertyAccess/PropertyAccessor.php
@@ -109,11 +109,6 @@ public function getValue(object|array $objectOrArray, string|PropertyPathInterfa
         return $propertyValues[\count($propertyValues) - 1][self::VALUE];
     }
 
-    /**
-     * @template T of object|array
-     * @param T $objectOrArray
-     * @param-out ($objectOrArray is array ? array : T) $objectOrArray
-     */
     public function setValue(object|array &$objectOrArray, string|PropertyPathInterface $propertyPath, mixed $value): void
     {
         if (\is_object($objectOrArray) && (false === strpbrk((string) $propertyPath, '.[') || $objectOrArray instanceof \stdClass && property_exists($objectOrArray, $propertyPath))) {
diff --git a/src/Symfony/Component/PropertyAccess/PropertyAccessorInterface.php b/src/Symfony/Component/PropertyAccess/PropertyAccessorInterface.php
@@ -39,6 +39,12 @@ interface PropertyAccessorInterface
      *
      * If neither is found, an exception is thrown.
      *
+     * @template T of object|array
+     *
+     * @param T $objectOrArray
+     *
+     * @param-out ($objectOrArray is array ? array : T) $objectOrArray
+     *
      * @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

Original file line number	Diff line number	Diff line change
`@@ -109,11 +109,6 @@ public function getValue(object\|array $objectOrArray, string\|PropertyPathInterfa`
`109`	`109`	`return $propertyValues[\count($propertyValues) - 1][self::VALUE];`
`110`	`110`	`}`
`111`	`111`
`112`		`- /**`
`113`		`- * @template T of object\|array`
`114`		`- * @param T $objectOrArray`
`115`		`- * @param-out ($objectOrArray is array ? array : T) $objectOrArray`
`116`		`- */`
`117`	`112`	`public function setValue(object\|array &$objectOrArray, string\|PropertyPathInterface $propertyPath, mixed $value): void`
`118`	`113`	`{`
`119`	`114`	`if (\is_object($objectOrArray) && (false === strpbrk((string) $propertyPath, '.[') \|\| $objectOrArray instanceof \stdClass && property_exists($objectOrArray, $propertyPath))) {`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,12 @@ interface PropertyAccessorInterface`
`39`	`39`	`*`
`40`	`40`	`* If neither is found, an exception is thrown.`
`41`	`41`	`*`
	`42`	`+ * @template T of object\|array`
	`43`	`+ *`
	`44`	`+ * @param T $objectOrArray`
	`45`	`+ *`
	`46`	`+ * @param-out ($objectOrArray is array ? array : T) $objectOrArray`
	`47`	`+ *`
`42`	`48`	`* @throws Exception\InvalidArgumentException If the property path is invalid`
`43`	`49`	`* @throws Exception\AccessException If a property/index does not exist or is not public`
`44`	`50`	`* @throws Exception\UnexpectedTypeException If a value within the path is neither object nor array`