[PropertyAccess][PropertyInfo] customize behavior for property hooks on read and write #59246

xavierleune · 2024-12-18T10:10:28Z

Q	A
Branch?	7.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Issues	¤
License	MIT

This pull requests adds 2 new (tiny) features:

PropertyInfo: expose data around property hooks for readInfo and writeInfo
PropertyAccess: allow the end user to customize behavior around property hooks, to bypass them if needed

Have a nice day!

xavierleune · 2024-12-18T10:19:23Z

src/Symfony/Component/PropertyInfo/Tests/Fixtures/VirtualProperties.php

-    public bool $virtualSetHookOnly { set => $value; }
-    public bool $virtualHook { get => true; set => $value; }
+    public bool $virtualSetHookOnly { set (bool $value) {  } }
+    public bool $virtualHook { get => true; set (bool $value) {  } }


I updated this fixtures because PHP does not report these properties as Virtual, see reproducer

xavierleune · 2024-12-18T10:49:46Z

Tests are failing on 8.2 / highest deps because of other components (Bridge\twig, Bundle\FrameworkBundle, Component\HttpKernel). It leaves us with psalm for which PHP 8.4 support can be tracked here: vimeo/psalm#11107. Not sure how to deal with it here.

src/Symfony/Component/PropertyInfo/CHANGELOG.md

src/Symfony/Component/PropertyInfo/Extractor/ReflectionExtractor.php

src/Symfony/Component/PropertyAccess/PropertyAccessor.php

xavierleune · 2024-12-20T13:39:56Z

@mtarld Thanks for your feedback, I think everything is covered now :)

src/Symfony/Component/PropertyAccess/PropertyAccessor.php

src/Symfony/Component/PropertyInfo/Extractor/ReflectionExtractor.php

src/Symfony/Component/PropertyAccess/PropertyAccessor.php

src/Symfony/Component/PropertyInfo/Extractor/ReflectionExtractor.php

xavierleune · 2025-03-20T10:14:37Z

Thanks @mtarld for your previous review, sorry I took so long to make the changes.

src/Symfony/Component/PropertyAccess/PropertyAccessor.php

xavierleune · 2025-03-24T09:03:44Z

@OskarStark thanks for your feedback, I renamed the variables.

xavierleune · 2025-03-26T10:45:55Z

Hi @mtarld do you think we might be good on this pull request ? Thanks ! 🙏

src/Symfony/Component/PropertyAccess/CHANGELOG.md

OskarStark · 2025-04-01T08:06:12Z

Would it be sufficient to split those PR into two separate feature PRs?

src/Symfony/Component/PropertyAccess/PropertyAccessor.php

src/Symfony/Component/PropertyAccess/Tests/PropertyAccessorTest.php

mtarld · 2025-04-01T08:56:11Z

src/Symfony/Component/PropertyInfo/Extractor/ReflectionExtractor.php

+        if ($hasProperty && (($r = $reflClass->getProperty($property))->getModifiers() & $this->propertyReflectionFlags)) {
+            return new PropertyReadInfo(PropertyReadInfo::TYPE_PROPERTY, $property, $this->getReadVisibilityForProperty($r), $r->isStatic(), true, $this->propertyHasHook($r, 'get'), $this->propertyIsVirtual($r));
        }

-        if ($hasProperty && (($r = $reflClass->getProperty($property))->getModifiers() & $this->propertyReflectionFlags)) {
-            return new PropertyReadInfo(PropertyReadInfo::TYPE_PROPERTY, $property, $this->getReadVisibilityForProperty($r), $r->isStatic(), true);
+        if ($allowMagicGet && $reflClass->hasMethod('__get') && (($r = $reflClass->getMethod('__get'))->getModifiers() & $this->methodReflectionFlags)) {
+            return new PropertyReadInfo(PropertyReadInfo::TYPE_PROPERTY, $property, PropertyReadInfo::VISIBILITY_PUBLIC, false, $r->returnsReference(), false, false);
        }


Why these ifs has been inverted?

See that comment #59246 (comment)

xavierleune · 2025-04-09T13:26:42Z

@mtarld thanks for the feedback

stof

I'm not sure I like this new feature of PropertyAccess. Until now, PropertyAccess never accesses the internal state of the object through Reflection (Reflection is used only for instrospection of the class structure). All reads and writes are done through the public API of the class until now.

src/Symfony/Component/PropertyAccess/PropertyAccessor.php

stof · 2025-04-09T13:30:46Z

src/Symfony/Component/PropertyAccess/PropertyAccessor.php

@@ -47,6 +47,10 @@ class PropertyAccessor implements PropertyAccessorInterface
    /** @var int Allow magic __call methods */
    public const MAGIC_CALL = ReflectionExtractor::ALLOW_MAGIC_CALL;

+    public const BYPASS_PROPERTY_HOOK_NONE = 0;
+    public const BYPASS_PROPERTY_HOOK_READ = 1 << 1;
+    public const BYPASS_PROPERTY_HOOK_WRITE = 1 << 0;


constants for a bit mask are generally defined in increasing order (so that new cases are added at the end of the list). This reverse order is unusual to me

…ty hooks on read and write

xavierleune · 2025-05-06T08:35:58Z

@stof I thought it would be very relevant in this component as this follows new opportunities offered by the language, wdyt ?

nicolas-grekas

LGTM, I just have minor comments

nicolas-grekas · 2025-06-23T12:46:20Z

src/Symfony/Component/PropertyAccess/CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========

+7.3


Suggested change

7.3

7.4

nicolas-grekas · 2025-06-23T12:48:06Z

src/Symfony/Component/PropertyAccess/PropertyAccessor.php

+     * @param int-mask-of<self::BYPASS_PROPERTY_HOOK_*> $bypassPropertyHooks A bitwise combination of the BYPASS_PROPERTY_HOOK_* constants
+     *                               to specify the hooks you want to bypass,
+     *                               or self::BYPASS_PROPERTY_HOOK_NONE for none


looks like the previous arguments could also nicely benefit from similar int-mask-of
let's align them also

the text looks redundant to me:

Suggested change

* @param int-mask-of<self::BYPASS_PROPERTY_HOOK_*> $bypassPropertyHooks A bitwise combination of the BYPASS_PROPERTY_HOOK_* constants

* to specify the hooks you want to bypass,

* or self::BYPASS_PROPERTY_HOOK_NONE for none

* @param int-mask-of<self::BYPASS_PROPERTY_HOOK_*> $bypassPropertyHooks

nicolas-grekas · 2025-06-23T12:53:48Z

src/Symfony/Component/PropertyAccess/CHANGELOG.md

+7.3
+---
+
+ * Allow to customize behavior for property hooks on read and write


Suggested change

* Allow to customize behavior for property hooks on read and write

* Add `PropertyAccessor::BYPASS_PROPERTY_HOOK_*` constants to customize behavior for property hooks

nicolas-grekas · 2025-06-23T13:01:41Z

src/Symfony/Component/PropertyInfo/Extractor/ReflectionExtractor.php

@@ -894,6 +894,16 @@ private function isMethodAccessible(\ReflectionClass $class, string $methodName,
        return [false, $errors];
    }

+    private function propertyHasHook(\ReflectionProperty $property, string $hookType): bool
+    {
+        return \PHP_VERSION_ID >= 80400 && $property->hasHook(\PropertyHookType::from($hookType));


I'd prefer inlining these two methods: they'd look needles to me on 8.0

nicolas-grekas · 2025-06-23T13:02:09Z

src/Symfony/Component/PropertyAccess/composer.json

@@ -17,7 +17,7 @@
    ],
    "require": {
        "php": ">=8.2",
-        "symfony/property-info": "^6.4|^7.0"
+        "symfony/property-info": "^7.3"


Suggested change

"symfony/property-info": "^7.3"

"symfony/property-info": "^7.4|^8.0"

nicolas-grekas · 2025-06-23T13:02:33Z

src/Symfony/Component/PropertyInfo/CHANGELOG.md

@@ -4,6 +4,7 @@ CHANGELOG
 7.3
 ---

+ * Gather data from property hooks in ReflectionExtractor


Suggested change

* Gather data from property hooks in ReflectionExtractor

* Gather info about property hooks in ReflectionExtractor

stof · 2025-06-23T13:09:11Z

@xavierleune having property hooks in the language does not mean that accessing the backing value of a hook is a public API of the class.
What you are suggesting here is exactly equivalent to using ReflectionProperty to read private properties of a class instead of calling a public getter (than might do more that returning the raw value).

Thinking about this again, I'm actually voting -1 on this feature. I'd like to keep the existing behavior of the component that always uses the public API of the class to access things. This makes things a lot easier to reason about (and to document).

xavierleune requested a review from dunglas as a code owner December 18, 2024 10:10

carsonbot added Status: Needs Review Feature PropertyAccess PropertyInfo labels Dec 18, 2024

carsonbot added this to the 7.3 milestone Dec 18, 2024

carsonbot changed the title ~~[PropertyInfo] [PropertyAccess] Feature: customize behavior for property hooks on read and write~~ [PropertyAccess][PropertyInfo] Feature: customize behavior for property hooks on read and write Dec 18, 2024

xavierleune force-pushed the feature/property-hooks branch from c4ef85d to 399efcf Compare December 18, 2024 10:11

xavierleune commented Dec 18, 2024

View reviewed changes

xavierleune force-pushed the feature/property-hooks branch 2 times, most recently from 0900ef7 to 379e96c Compare December 18, 2024 10:38

xavierleune mentioned this pull request Dec 19, 2024

Support for attributes ccmbenchmark/ting_bundle#23

Merged

mtarld reviewed Dec 20, 2024

View reviewed changes

xavierleune force-pushed the feature/property-hooks branch 3 times, most recently from a396856 to 73f2e3f Compare December 20, 2024 13:39

mtarld requested changes Dec 20, 2024

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Dec 20, 2024

xavierleune force-pushed the feature/property-hooks branch 2 times, most recently from bd1f4a1 to 0c5bb13 Compare December 20, 2024 16:10

mtarld requested changes Jan 10, 2025

View reviewed changes

src/Symfony/Component/PropertyAccess/PropertyAccessor.php Outdated Show resolved Hide resolved

src/Symfony/Component/PropertyInfo/Extractor/ReflectionExtractor.php Outdated Show resolved Hide resolved

src/Symfony/Component/PropertyInfo/Extractor/ReflectionExtractor.php Show resolved Hide resolved

xavierleune force-pushed the feature/property-hooks branch from 0c5bb13 to 0eaa1d4 Compare March 20, 2025 10:10

OskarStark changed the title ~~[PropertyAccess][PropertyInfo] Feature: customize behavior for property hooks on read and write~~ [PropertyAccess][PropertyInfo] customize behavior for property hooks on read and write Mar 21, 2025

OskarStark reviewed Mar 21, 2025

View reviewed changes

xavierleune force-pushed the feature/property-hooks branch from 0eaa1d4 to 0d100a9 Compare March 24, 2025 09:02

OskarStark reviewed Apr 1, 2025

View reviewed changes

src/Symfony/Component/PropertyAccess/CHANGELOG.md Outdated Show resolved Hide resolved

mtarld reviewed Apr 1, 2025

View reviewed changes

xavierleune force-pushed the feature/property-hooks branch from 0d100a9 to 3990cad Compare April 9, 2025 13:23

stof reviewed Apr 9, 2025

View reviewed changes

xavierleune force-pushed the feature/property-hooks branch from 3990cad to 7963304 Compare April 10, 2025 07:40

[PropertyInfo][PropertyAccess] Feature: customize behavior for proper…

e4901fb

…ty hooks on read and write

xavierleune force-pushed the feature/property-hooks branch from 7963304 to e4901fb Compare May 5, 2025 09:12

fabpot modified the milestones: 7.3, 7.4 May 26, 2025

nicolas-grekas reviewed Jun 23, 2025

View reviewed changes

	* Allow to customize behavior for property hooks on read and write
	* Add `PropertyAccessor::BYPASS_PROPERTY_HOOK_*` constants to customize behavior for property hooks

	"symfony/property-info": "^7.3"
	"symfony/property-info": "^7.4\|^8.0"

	* Gather data from property hooks in ReflectionExtractor
	* Gather info about property hooks in ReflectionExtractor

Uh oh!

[PropertyAccess][PropertyInfo] customize behavior for property hooks on read and write #59246

Are you sure you want to change the base?

[PropertyAccess][PropertyInfo] customize behavior for property hooks on read and write #59246

Conversation

xavierleune commented Dec 18, 2024 • edited by nicolas-grekas Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xavierleune commented Dec 18, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xavierleune commented Dec 20, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xavierleune commented Mar 20, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xavierleune commented Mar 24, 2025

Uh oh!

xavierleune commented Mar 26, 2025

Uh oh!

Uh oh!

OskarStark commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xavierleune commented Apr 9, 2025

Uh oh!

stof left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xavierleune commented May 6, 2025

Uh oh!

nicolas-grekas left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xavierleune commented Dec 18, 2024 •

edited by nicolas-grekas

Loading

OskarStark commented Apr 1, 2025 •

edited

Loading

stof left a comment •

edited

Loading