Skip to content

Commit 0eaa1d4

Browse files
xavierleunexavierleune
committed
[PropertyInfo][PropertyAccess] Feature: customize behavior for property hooks on read and write
1 parent 07e020a commit 0eaa1d4

File tree

12 files changed

+191
-15
lines changed

12 files changed

+191
-15
lines changed

‎src/Symfony/Component/PropertyAccess/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CHANGELOG
22
=========
33

4+
7.3
5+
---
6+
7+
* Allow to customize behavior for property hooks on read and write
8+
49
7.0
510
---
611

‎src/Symfony/Component/PropertyAccess/PropertyAccessor.php

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ class PropertyAccessor implements PropertyAccessorInterface
4747
/** @var int Allow magic __call methods */
4848
public const MAGIC_CALL = ReflectionExtractor::ALLOW_MAGIC_CALL;
4949

50+
public const DO_NOT_BYPASS_PROPERTY_HOOKS = 0;
51+
public const BYPASS_PROPERTY_HOOK_READ = 1 << 1;
52+
public const BYPASS_PROPERTY_HOOK_WRITE = 1 << 0;
53+
5054
public const DO_NOT_THROW = 0;
5155
public const THROW_ON_INVALID_INDEX = 1;
5256
public const THROW_ON_INVALID_PROPERTY_PATH = 2;
@@ -67,6 +71,7 @@ class PropertyAccessor implements PropertyAccessorInterface
6771
private PropertyWriteInfoExtractorInterface $writeInfoExtractor;
6872
private array $readPropertyCache = [];
6973
private array $writePropertyCache = [];
74+
private int $byPassPropertyHooks;
7075

7176
/**
7277
* Should not be used by application code. Use
@@ -75,21 +80,26 @@ class PropertyAccessor implements PropertyAccessorInterface
7580
* @param int $magicMethodsFlags A bitwise combination of the MAGIC_* constants
7681
* to specify the allowed magic methods (__get, __set, __call)
7782
* or self::DISALLOW_MAGIC_METHODS for none
78-
* @param int $throw A bitwise combination of the THROW_* constants
83+
* @param int $throw A bitwise combination of the THROW_* constants
7984
* to specify when exceptions should be thrown
85+
* @param int $byPassPropertyHooks A bitwise combination of the BYPASS_HOOKS_* constants
86+
* to specify the hooks you want to bypass,
87+
* or self::DO_NOT_BYPASS_HOOKS_ON_PROPERTY for none
8088
*/
8189
public function __construct(
8290
private int $magicMethodsFlags = self::MAGIC_GET | self::MAGIC_SET,
8391
int $throw = self::THROW_ON_INVALID_PROPERTY_PATH,
8492
?CacheItemPoolInterface $cacheItemPool = null,
8593
?PropertyReadInfoExtractorInterface $readInfoExtractor = null,
8694
?PropertyWriteInfoExtractorInterface $writeInfoExtractor = null,
95+
int $byPassPropertyHooks = self::DO_NOT_BYPASS_PROPERTY_HOOKS,
8796
) {
8897
$this->ignoreInvalidIndices = 0 === ($throw & self::THROW_ON_INVALID_INDEX);
8998
$this->cacheItemPool = $cacheItemPool instanceof NullAdapter ? null : $cacheItemPool; // Replace the NullAdapter by the null value
9099
$this->ignoreInvalidProperty = 0 === ($throw & self::THROW_ON_INVALID_PROPERTY_PATH);
91100
$this->readInfoExtractor = $readInfoExtractor ?? new ReflectionExtractor([], null, null, false);
92101
$this->writeInfoExtractor = $writeInfoExtractor ?? new ReflectionExtractor(['set'], null, null, false);
102+
$this->byPassPropertyHooks = \PHP_VERSION_ID >= 80400 ? $byPassPropertyHooks : self::DO_NOT_BYPASS_PROPERTY_HOOKS;
93103
}
94104

95105
public function getValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath): mixed
@@ -414,12 +424,21 @@ private function readProperty(array $zval, string $property, bool $ignoreInvalid
414424
throw $e;
415425
}
416426
} elseif (PropertyReadInfo::TYPE_PROPERTY === $type) {
417-
if (!isset($object->$name) && !\array_key_exists($name, (array) $object)) {
427+
$valueSet = false;
428+
$useBypass = $this->byPassPropertyHooks & self::BYPASS_PROPERTY_HOOK_READ && $access->hasHook() && !$access->isVirtual();
429+
$valueSeemsToBeNotSet = !isset($object->$name) && !\array_key_exists($name, (array) $object);
430+
if ($valueSeemsToBeNotSet || $useBypass) {
418431
try {
419432
$r = new \ReflectionProperty($class, $name);
433+
if ($valueSeemsToBeNotSet) {
434+
if ($r->isPublic() && !$r->hasType()) {
435+
throw new UninitializedPropertyException(\sprintf('The property "%s::$%s" is not initialized.', $class, $name));
436+
}
437+
}
420438

421-
if ($r->isPublic() && !$r->hasType()) {
422-
throw new UninitializedPropertyException(\sprintf('The property "%s::$%s" is not initialized.', $class, $name));
439+
if ($useBypass) {
440+
$result[self::VALUE] = $r->getRawValue($object);
441+
$valueSet = true;
423442
}
424443
} catch (\ReflectionException $e) {
425444
if (!$ignoreInvalidProperty) {
@@ -428,7 +447,9 @@ private function readProperty(array $zval, string $property, bool $ignoreInvalid
428447
}
429448
}
430449

431-
$result[self::VALUE] = $object->$name;
450+
if (!$valueSet) {
451+
$result[self::VALUE] = $object->$name;
452+
}
432453

433454
if (isset($zval[self::REF]) && $access->canBeReference()) {
434455
$result[self::REF] = &$object->$name;
@@ -531,7 +552,12 @@ private function writeProperty(array $zval, string $property, mixed $value, bool
531552
if (PropertyWriteInfo::TYPE_METHOD === $type) {
532553
$object->{$mutator->getName()}($value);
533554
} elseif (PropertyWriteInfo::TYPE_PROPERTY === $type) {
534-
$object->{$mutator->getName()} = $value;
555+
if ($this->byPassPropertyHooks & self::BYPASS_PROPERTY_HOOK_WRITE) {
556+
$r = new \ReflectionProperty($class, $mutator->getName());
557+
$r->setRawValue($object, $value);
558+
} else {
559+
$object->{$mutator->getName()} = $value;
560+
}
535561
} elseif (PropertyWriteInfo::TYPE_ADDER_AND_REMOVER === $type) {
536562
$this->writeCollection($zval, $property, $value, $mutator->getAdderInfo(), $mutator->getRemoverInfo());
537563
}

‎src/Symfony/Component/PropertyAccess/Tests/Fixtures/TestClassHooks.php

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
namespace Symfony\Component\PropertyAccess\Tests\Fixtures;
4+
5+
class TestClassHooks
6+
{
7+
public string $hookGetOnly = 'default' {
8+
get => $this->hookGetOnly . ' (hooked on get)';
9+
}
10+
11+
public string $hookSetOnly = 'default' {
12+
set(string $value) {
13+
$this->hookSetOnly = $value . ' (hooked on set)';
14+
}
15+
}
16+
17+
public string $hookBoth = 'default' {
18+
get => $this->hookBoth . ' (hooked on get)';
19+
set(string $value) {
20+
$this->hookBoth = $value . ' (hooked on set)';
21+
}
22+
}
23+
}

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

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
use Symfony\Component\PropertyAccess\Tests\Fixtures\TestAdderRemoverInvalidArgumentLength;
2727
use Symfony\Component\PropertyAccess\Tests\Fixtures\TestAdderRemoverInvalidMethods;
2828
use Symfony\Component\PropertyAccess\Tests\Fixtures\TestClass;
29+
use Symfony\Component\PropertyAccess\Tests\Fixtures\TestClassHooks;
2930
use Symfony\Component\PropertyAccess\Tests\Fixtures\TestClassIsWritable;
3031
use Symfony\Component\PropertyAccess\Tests\Fixtures\TestClassMagicCall;
3132
use Symfony\Component\PropertyAccess\Tests\Fixtures\TestClassMagicGet;
@@ -1030,6 +1031,45 @@ public function testIsReadableWithMissingPropertyAndLazyGhost()
10301031
$this->assertFalse($this->propertyAccessor->isReadable($lazyGhost, 'dummy'));
10311032
}
10321033

1034+
/**
1035+
* @requires PHP 8.4
1036+
*/
1037+
public function testBypassHookOnRead()
1038+
{
1039+
$instance = new TestClassHooks();
1040+
$propertyAccessor = new PropertyAccessor(byPassPropertyHooks: PropertyAccessor::BYPASS_PROPERTY_HOOK_READ);
1041+
$this->assertSame('default', $propertyAccessor->getValue($instance, 'hookGetOnly'));
1042+
$this->assertSame('default (hooked on get)', $this->propertyAccessor->getValue($instance, 'hookGetOnly'));
1043+
$this->assertSame('default', $propertyAccessor->getValue($instance, 'hookSetOnly'));
1044+
$this->assertSame('default', $this->propertyAccessor->getValue($instance, 'hookSetOnly'));
1045+
$this->assertSame('default', $propertyAccessor->getValue($instance, 'hookBoth'));
1046+
$this->assertSame('default (hooked on get)', $this->propertyAccessor->getValue($instance, 'hookBoth'));
1047+
}
1048+
1049+
/**
1050+
* @requires PHP 8.4
1051+
*/
1052+
public function testBypassHookOnWrite()
1053+
{
1054+
$instance = new TestClassHooks();
1055+
$propertyAccessor = new PropertyAccessor(byPassPropertyHooks: PropertyAccessor::BYPASS_PROPERTY_HOOK_WRITE);
1056+
$propertyAccessor->setValue($instance, 'hookGetOnly', 'edited');
1057+
$propertyAccessor->setValue($instance, 'hookSetOnly', 'edited');
1058+
$propertyAccessor->setValue($instance, 'hookBoth', 'edited');
1059+
1060+
$instance2 = new TestClassHooks();
1061+
$this->propertyAccessor->setValue($instance2, 'hookGetOnly', 'edited');
1062+
$this->propertyAccessor->setValue($instance2, 'hookSetOnly', 'edited');
1063+
$this->propertyAccessor->setValue($instance2, 'hookBoth', 'edited');
1064+
1065+
$this->assertSame('edited (hooked on get)', $propertyAccessor->getValue($instance, 'hookGetOnly'));
1066+
$this->assertSame('edited (hooked on get)', $this->propertyAccessor->getValue($instance2, 'hookGetOnly'));
1067+
$this->assertSame('edited', $propertyAccessor->getValue($instance, 'hookSetOnly'));
1068+
$this->assertSame('edited (hooked on set)', $this->propertyAccessor->getValue($instance2, 'hookSetOnly'));
1069+
$this->assertSame('edited (hooked on get)', $propertyAccessor->getValue($instance, 'hookBoth'));
1070+
$this->assertSame('edited (hooked on set) (hooked on get)', $this->propertyAccessor->getValue($instance2, 'hookBoth'));
1071+
}
1072+
10331073
private function createUninitializedObjectPropertyGhost(): UninitializedObjectProperty
10341074
{
10351075
if (\PHP_VERSION_ID < 80400) {

‎src/Symfony/Component/PropertyAccess/composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
],
1818
"require": {
1919
"php": ">=8.2",
20-
"symfony/property-info": "^6.4|^7.0"
20+
"symfony/property-info": "^7.3"
2121
},
2222
"require-dev": {
2323
"symfony/cache": "^6.4|^7.0"

‎src/Symfony/Component/PropertyInfo/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ CHANGELOG
44
7.3
55
---
66

7+
* Gather data from property hooks in ReflectionExtractor
78
* Add support for `non-positive-int`, `non-negative-int` and `non-zero-int` PHPStan types to `PhpStanExtractor`
89
* Add `PropertyDescriptionExtractorInterface` to `PhpStanExtractor`
910

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

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -383,12 +383,12 @@ public function getReadInfo(string $class, string $property, array $context = []
383383
return new PropertyReadInfo(PropertyReadInfo::TYPE_METHOD, $getsetter, $this->getReadVisibilityForMethod($method), $method->isStatic(), false);
384384
}
385385

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

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

394394
if ($allowMagicCall && $reflClass->hasMethod('__call') && ($reflClass->getMethod('__call')->getModifiers() & $this->methodReflectionFlags)) {
@@ -472,7 +472,7 @@ public function getWriteInfo(string $class, string $property, array $context = [
472472
if ($reflClass->hasProperty($property) && ($reflClass->getProperty($property)->getModifiers() & $this->propertyReflectionFlags)) {
473473
$reflProperty = $reflClass->getProperty($property);
474474
if (!$reflProperty->isReadOnly()) {
475-
return new PropertyWriteInfo(PropertyWriteInfo::TYPE_PROPERTY, $property, $this->getWriteVisibilityForProperty($reflProperty), $reflProperty->isStatic());
475+
return new PropertyWriteInfo(PropertyWriteInfo::TYPE_PROPERTY, $property, $this->getWriteVisibilityForProperty($reflProperty), $reflProperty->isStatic(), $this->propertyHasHook($reflProperty, 'set'));
476476
}
477477

478478
$errors[] = [\sprintf('The property "%s" in class "%s" is a promoted readonly property.', $property, $reflClass->getName())];
@@ -482,7 +482,7 @@ public function getWriteInfo(string $class, string $property, array $context = [
482482
if ($allowMagicSet) {
483483
[$accessible, $methodAccessibleErrors] = $this->isMethodAccessible($reflClass, '__set', 2);
484484
if ($accessible) {
485-
return new PropertyWriteInfo(PropertyWriteInfo::TYPE_PROPERTY, $property, PropertyWriteInfo::VISIBILITY_PUBLIC, false);
485+
return new PropertyWriteInfo(PropertyWriteInfo::TYPE_PROPERTY, $property, PropertyWriteInfo::VISIBILITY_PUBLIC, false, false);
486486
}
487487

488488
$errors[] = $methodAccessibleErrors;
@@ -885,6 +885,16 @@ private function isMethodAccessible(\ReflectionClass $class, string $methodName,
885885
return [false, $errors];
886886
}
887887

888+
private function propertyHasHook(\ReflectionProperty $property, string $hookType): bool
889+
{
890+
return \PHP_VERSION_ID >= 80400 && $property->hasHook(\PropertyHookType::from($hookType));
891+
}
892+
893+
private function propertyIsVirtual(\ReflectionProperty $property): bool
894+
{
895+
return \PHP_VERSION_ID >= 80400 && $property->isVirtual();
896+
}
897+
888898
/**
889899
* Camelizes a given string.
890900
*/

‎src/Symfony/Component/PropertyInfo/PropertyReadInfo.php

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ public function __construct(
3131
private readonly string $visibility,
3232
private readonly bool $static,
3333
private readonly bool $byRef,
34+
private readonly ?bool $hasHook = null,
35+
private readonly ?bool $isVirtual = null,
3436
) {
3537
}
3638

@@ -67,4 +69,14 @@ public function canBeReference(): bool
6769
{
6870
return $this->byRef;
6971
}
72+
73+
public function hasHook(): ?bool
74+
{
75+
return $this->hasHook;
76+
}
77+
78+
public function isVirtual(): ?bool
79+
{
80+
return $this->isVirtual;
81+
}
7082
}

‎src/Symfony/Component/PropertyInfo/PropertyWriteInfo.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ public function __construct(
3737
private readonly ?string $name = null,
3838
private readonly ?string $visibility = null,
3939
private readonly ?bool $static = null,
40+
private readonly ?bool $hasHook = null,
4041
) {
4142
}
4243

@@ -114,4 +115,9 @@ public function hasErrors(): bool
114115
{
115116
return (bool) \count($this->errors);
116117
}
118+
119+
public function hasHook(): ?bool
120+
{
121+
return $this->hasHook;
122+
}
117123
}

‎src/Symfony/Component/PropertyInfo/Tests/Extractor/ReflectionExtractorTest.php

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
use Symfony\Component\PropertyInfo\Tests\Fixtures\ConstructorDummy;
2121
use Symfony\Component\PropertyInfo\Tests\Fixtures\DefaultValue;
2222
use Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy;
23+
use Symfony\Component\PropertyInfo\Tests\Fixtures\HookedProperties;
2324
use Symfony\Component\PropertyInfo\Tests\Fixtures\NotInstantiable;
2425
use Symfony\Component\PropertyInfo\Tests\Fixtures\ParentDummy;
2526
use Symfony\Component\PropertyInfo\Tests\Fixtures\Php71Dummy;
@@ -765,8 +766,14 @@ public function testAsymmetricVisibilityAllowPrivateOnly()
765766
public function testVirtualProperties()
766767
{
767768
$this->assertTrue($this->extractor->isReadable(VirtualProperties::class, 'virtualNoSetHook'));
769+
$this->assertTrue($this->extractor->getReadInfo(VirtualProperties::class, 'virtualNoSetHook')->isVirtual());
770+
$this->assertTrue($this->extractor->getReadInfo(VirtualProperties::class, 'virtualNoSetHook')->hasHook());
768771
$this->assertTrue($this->extractor->isReadable(VirtualProperties::class, 'virtualSetHookOnly'));
772+
$this->assertTrue($this->extractor->getReadInfo(VirtualProperties::class, 'virtualSetHookOnly')->isVirtual());
773+
$this->assertFalse($this->extractor->getReadInfo(VirtualProperties::class, 'virtualSetHookOnly')->hasHook());
769774
$this->assertTrue($this->extractor->isReadable(VirtualProperties::class, 'virtualHook'));
775+
$this->assertTrue($this->extractor->getReadInfo(VirtualProperties::class, 'virtualHook')->isVirtual());
776+
$this->assertTrue($this->extractor->getReadInfo(VirtualProperties::class, 'virtualHook')->hasHook());
770777
$this->assertFalse($this->extractor->isWritable(VirtualProperties::class, 'virtualNoSetHook'));
771778
$this->assertTrue($this->extractor->isWritable(VirtualProperties::class, 'virtualSetHookOnly'));
772779
$this->assertTrue($this->extractor->isWritable(VirtualProperties::class, 'virtualHook'));
@@ -791,6 +798,22 @@ public function testAsymmetricVisibilityMutator(string $property, string $readVi
791798
$this->assertSame($writeVisibility, $writeMutator->getVisibility());
792799
}
793800

801+
/**
802+
* @requires PHP 8.4
803+
*/
804+
public function testHookedProperties()
805+
{
806+
$this->assertTrue($this->extractor->getReadInfo(HookedProperties::class, 'hookGetOnly')->hasHook());
807+
$this->assertFalse($this->extractor->getReadInfo(HookedProperties::class, 'hookGetOnly')->isVirtual());
808+
$this->assertFalse($this->extractor->getWriteInfo(HookedProperties::class, 'hookGetOnly')->hasHook());
809+
$this->assertFalse($this->extractor->getReadInfo(HookedProperties::class, 'hookSetOnly')->hasHook());
810+
$this->assertFalse($this->extractor->getReadInfo(HookedProperties::class, 'hookSetOnly')->isVirtual());
811+
$this->assertTrue($this->extractor->getWriteInfo(HookedProperties::class, 'hookSetOnly')->hasHook());
812+
$this->assertTrue($this->extractor->getReadInfo(HookedProperties::class, 'hookBoth')->hasHook());
813+
$this->assertFalse($this->extractor->getReadInfo(HookedProperties::class, 'hookBoth')->isVirtual());
814+
$this->assertTrue($this->extractor->getWriteInfo(HookedProperties::class, 'hookBoth')->hasHook());
815+
}
816+
794817
public static function provideAsymmetricVisibilityMutator(): iterable
795818
{
796819
yield ['publicPrivate', PropertyReadInfo::VISIBILITY_PUBLIC, PropertyWriteInfo::VISIBILITY_PRIVATE];

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy