Skip to content

Commit 600802a

Browse files
kukulichkukulich
committed
Implemented property hooks
1 parent 5151935 commit 600802a

13 files changed

+913
-27
lines changed

‎phpstan.neon

+4
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ parameters:
2525
- phar://%currentWorkingDirectory%/test/unit/Fixture/autoload.phar/vendor/autoload.php
2626

2727
ignoreErrors:
28+
-
29+
identifier: class.notFound
30+
message: '#(unknown class|invalid type) PropertyHookType#'
31+
2832
-
2933
identifier: missingType.generics
3034
-

‎psalm-baseline.xml

+10
Original file line numberDiff line numberDiff line change
@@ -144,11 +144,15 @@
144144
<code><![CDATA[getEndLine]]></code>
145145
<code><![CDATA[getEndLine]]></code>
146146
<code><![CDATA[getEndLine]]></code>
147+
<code><![CDATA[getEndLine]]></code>
148+
<code><![CDATA[getReturnType]]></code>
149+
<code><![CDATA[getStartLine]]></code>
147150
<code><![CDATA[getStartLine]]></code>
148151
<code><![CDATA[getStartLine]]></code>
149152
<code><![CDATA[getStartLine]]></code>
150153
<code><![CDATA[getStartLine]]></code>
151154
<code><![CDATA[getStmts]]></code>
155+
<code><![CDATA[getStmts]]></code>
152156
<code><![CDATA[getSubNodeNames]]></code>
153157
<code><![CDATA[traverse]]></code>
154158
</ImpureMethodCall>
@@ -201,16 +205,22 @@
201205
<ImpureMethodCall>
202206
<code><![CDATA[__invoke]]></code>
203207
<code><![CDATA[classExists]]></code>
208+
<code><![CDATA[createFromNode]]></code>
204209
<code><![CDATA[getEndLine]]></code>
205210
<code><![CDATA[getStartLine]]></code>
211+
<code><![CDATA[getStmts]]></code>
212+
<code><![CDATA[getStmts]]></code>
206213
<code><![CDATA[isPrivate]]></code>
207214
<code><![CDATA[isPrivateSet]]></code>
208215
<code><![CDATA[isProtected]]></code>
209216
<code><![CDATA[isProtectedSet]]></code>
210217
<code><![CDATA[isPublic]]></code>
218+
<code><![CDATA[isPublic]]></code>
211219
<code><![CDATA[isReadonly]]></code>
212220
<code><![CDATA[isStatic]]></code>
213221
<code><![CDATA[traitExists]]></code>
222+
<code><![CDATA[traverse]]></code>
223+
<code><![CDATA[traverse]]></code>
214224
</ImpureMethodCall>
215225
</file>
216226
<file src="src/Reflection/ReflectionType.php">

‎src/Reflection/Adapter/ReflectionNamedType.php

+34-10
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,48 @@
1212
/** @psalm-immutable */
1313
final class ReflectionNamedType extends CoreReflectionNamedType
1414
{
15-
public function __construct(private BetterReflectionNamedType $betterReflectionType, private bool $allowsNull)
15+
/** @var non-empty-string */
16+
private string $nameType;
17+
18+
private bool $isBuiltin;
19+
20+
/** @var non-empty-string */
21+
private string $toString;
22+
23+
/** @param \Roave\BetterReflection\Reflection\ReflectionNamedType|non-empty-string $type */
24+
public function __construct(BetterReflectionNamedType|string $type, private bool $allowsNull = false)
1625
{
26+
if ($type instanceof BetterReflectionNamedType) {
27+
$nameType = $type->getName();
28+
$this->nameType = $nameType;
29+
$this->isBuiltin = self::computeIsBuiltin($nameType, $type->isBuiltin());
30+
$this->toString = $type->__toString();
31+
} else {
32+
$this->nameType = $type;
33+
$this->isBuiltin = true;
34+
$this->toString = $type;
35+
}
1736
}
1837

1938
public function getName(): string
2039
{
21-
return $this->betterReflectionType->getName();
40+
return $this->nameType;
2241
}
2342

2443
/** @return non-empty-string */
2544
public function __toString(): string
2645
{
27-
$type = strtolower($this->betterReflectionType->getName());
46+
$normalizedType = strtolower($this->nameType);
2847

2948
if (
3049
! $this->allowsNull
31-
|| $type === 'mixed'
32-
|| $type === 'null'
50+
|| $normalizedType === 'mixed'
51+
|| $normalizedType === 'null'
3352
) {
34-
return $this->betterReflectionType->__toString();
53+
return $this->toString;
3554
}
3655

37-
return '?' . $this->betterReflectionType->__toString();
56+
return '?' . $this->toString;
3857
}
3958

4059
public function allowsNull(): bool
@@ -44,12 +63,17 @@ public function allowsNull(): bool
4463

4564
public function isBuiltin(): bool
4665
{
47-
$type = strtolower($this->betterReflectionType->getName());
66+
return $this->isBuiltin;
67+
}
68+
69+
private static function computeIsBuiltin(string $namedType, bool $isBuiltin): bool
70+
{
71+
$normalizedType = strtolower($namedType);
4872

49-
if ($type === 'self' || $type === 'parent' || $type === 'static') {
73+
if ($normalizedType === 'self' || $normalizedType === 'parent' || $normalizedType === 'static') {
5074
return false;
5175
}
5276

53-
return $this->betterReflectionType->isBuiltin();
77+
return $isBuiltin;
5478
}
5579
}

‎src/Reflection/Adapter/ReflectionProperty.php

+89
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,16 @@
66

77
use ArgumentCountError;
88
use OutOfBoundsException;
9+
use PropertyHookType;
910
use ReflectionException as CoreReflectionException;
11+
use ReflectionMethod as CoreReflectionMethod;
1012
use ReflectionProperty as CoreReflectionProperty;
1113
use Roave\BetterReflection\Reflection\Exception\NoObjectProvided;
1214
use Roave\BetterReflection\Reflection\Exception\NotAnObject;
1315
use Roave\BetterReflection\Reflection\ReflectionAttribute as BetterReflectionAttribute;
16+
use Roave\BetterReflection\Reflection\ReflectionMethod as BetterReflectionMethod;
1417
use Roave\BetterReflection\Reflection\ReflectionProperty as BetterReflectionProperty;
18+
use Roave\BetterReflection\Reflection\ReflectionPropertyHookType as BetterReflectionPropertyHookType;
1519
use Throwable;
1620
use TypeError;
1721
use ValueError;
@@ -30,6 +34,20 @@ final class ReflectionProperty extends CoreReflectionProperty
3034
*/
3135
public const IS_FINAL_COMPATIBILITY = 32;
3236

37+
/**
38+
* @internal
39+
*
40+
* @see CoreReflectionProperty::IS_ABSTRACT
41+
*/
42+
public const IS_ABSTRACT_COMPATIBILITY = 64;
43+
44+
/**
45+
* @internal
46+
*
47+
* @see CoreReflectionProperty::IS_VIRTUAL
48+
*/
49+
public const IS_VIRTUAL_COMPATIBILITY = 512;
50+
3351
/**
3452
* @internal
3553
*
@@ -156,6 +174,12 @@ public function isFinal(): bool
156174
return $this->betterReflectionProperty->isFinal();
157175
}
158176

177+
/** @psalm-mutation-free */
178+
public function isAbstract(): bool
179+
{
180+
return $this->betterReflectionProperty->isAbstract();
181+
}
182+
159183
/** @psalm-mutation-free */
160184
public function isDefault(): bool
161185
{
@@ -250,6 +274,71 @@ public function isReadOnly(): bool
250274
return $this->betterReflectionProperty->isReadOnly();
251275
}
252276

277+
/** @psalm-mutation-free */
278+
public function isVirtual(): bool
279+
{
280+
return $this->betterReflectionProperty->isVirtual();
281+
}
282+
283+
public function hasHooks(): bool
284+
{
285+
return $this->betterReflectionProperty->hasHooks();
286+
}
287+
288+
/** @psalm-suppress UndefinedClass */
289+
public function hasHook(PropertyHookType $hookType): bool
290+
{
291+
return $this->betterReflectionProperty->hasHook(BetterReflectionPropertyHookType::fromCoreReflectionPropertyHookType($hookType));
292+
}
293+
294+
/** @psalm-suppress UndefinedClass */
295+
public function getHook(PropertyHookType $hookType): ReflectionMethod|null
296+
{
297+
$hook = $this->betterReflectionProperty->getHook(BetterReflectionPropertyHookType::fromCoreReflectionPropertyHookType($hookType));
298+
if ($hook === null) {
299+
return null;
300+
}
301+
302+
return new ReflectionMethod($hook);
303+
}
304+
305+
/** @return array{get?: ReflectionMethod, set?: ReflectionMethod} */
306+
public function getHooks(): array
307+
{
308+
return array_map(
309+
static fn (BetterReflectionMethod $betterReflectionMethod): CoreReflectionMethod => new ReflectionMethod($betterReflectionMethod),
310+
$this->betterReflectionProperty->getHooks(),
311+
);
312+
}
313+
314+
public function getSettableType(): ReflectionUnionType|ReflectionNamedType|ReflectionIntersectionType|null
315+
{
316+
$setHook = $this->betterReflectionProperty->getHook(BetterReflectionPropertyHookType::Set);
317+
if ($setHook !== null) {
318+
return ReflectionType::fromTypeOrNull($setHook->getParameters()[0]->getType());
319+
}
320+
321+
if ($this->isVirtual()) {
322+
return new ReflectionNamedType('never');
323+
}
324+
325+
return $this->getType();
326+
}
327+
328+
public function getRawValue(object $object): mixed
329+
{
330+
throw new Exception\NotImplemented('Not implemented');
331+
}
332+
333+
public function setRawValue(object $object, mixed $value): void
334+
{
335+
if ($this->hasHooks()) {
336+
throw new Exception\NotImplemented('Not implemented');
337+
}
338+
339+
$this->setValue($object, $value);
340+
}
341+
253342
public function __get(string $name): mixed
254343
{
255344
if ($name === 'name') {

‎src/Reflection/ReflectionClass.php

+4
Original file line numberDiff line numberDiff line change
@@ -571,6 +571,7 @@ private function createImmediateMethods(ClassNode|InterfaceNode|TraitNode|EnumNo
571571
$reflector,
572572
$methodNode,
573573
$this->locatedSource,
574+
$methodNode->name->name,
574575
$this->getNamespaceName(),
575576
$this,
576577
$this,
@@ -596,6 +597,8 @@ private function addEnumMethods(EnumNode $node, array $methods): array
596597
{
597598
$internalLocatedSource = new InternalLocatedSource('', $this->getName(), 'Core');
598599
$createMethod = function (string $name, array $params, Node\Identifier|Node\NullableType $returnType) use ($internalLocatedSource): ReflectionMethod {
600+
assert($name !== '');
601+
599602
/** @var array{flags: int, params: Node\Param[], returnType: Node\Identifier|Node\NullableType} $classMethodSubnodes */
600603
$classMethodSubnodes = [
601604
'flags' => Modifiers::PUBLIC | Modifiers::STATIC,
@@ -610,6 +613,7 @@ private function addEnumMethods(EnumNode $node, array $methods): array
610613
$classMethodSubnodes,
611614
),
612615
$internalLocatedSource,
616+
$name,
613617
$this->getNamespaceName(),
614618
$this,
615619
$this,

‎src/Reflection/ReflectionFunctionAbstract.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ abstract public function __toString(): string;
9898
abstract public function getShortName(): string;
9999

100100
/** @psalm-external-mutation-free */
101-
private function fillFromNode(MethodNode|Node\Stmt\Function_|Node\Expr\Closure|Node\Expr\ArrowFunction $node): void
101+
private function fillFromNode(MethodNode|Node\PropertyHook|Node\Stmt\Function_|Node\Expr\Closure|Node\Expr\ArrowFunction $node): void
102102
{
103103
$this->parameters = $this->createParameters($node);
104104
$this->returnsReference = $node->returnsByRef();
@@ -136,7 +136,7 @@ private function fillFromNode(MethodNode|Node\Stmt\Function_|Node\Expr\Closure|N
136136
}
137137

138138
/** @return array<non-empty-string, ReflectionParameter> */
139-
private function createParameters(Node\Stmt\ClassMethod|Node\Stmt\Function_|Node\Expr\Closure|Node\Expr\ArrowFunction $node): array
139+
private function createParameters(Node\Stmt\ClassMethod|Node\PropertyHook|Node\Stmt\Function_|Node\Expr\Closure|Node\Expr\ArrowFunction $node): array
140140
{
141141
$parameters = [];
142142

@@ -327,7 +327,7 @@ public function couldThrow(): bool
327327
return $this->couldThrow;
328328
}
329329

330-
private function computeCouldThrow(MethodNode|Node\Stmt\Function_|Node\Expr\Closure|Node\Expr\ArrowFunction $node): bool
330+
private function computeCouldThrow(MethodNode|Node\PropertyHook|Node\Stmt\Function_|Node\Expr\Closure|Node\Expr\ArrowFunction $node): bool
331331
{
332332
$statements = $node->getStmts();
333333

@@ -498,7 +498,7 @@ public function getTentativeReturnType(): ReflectionNamedType|ReflectionUnionTyp
498498
return $this->returnType;
499499
}
500500

501-
private function createReturnType(MethodNode|Node\Stmt\Function_|Node\Expr\Closure|Node\Expr\ArrowFunction $node): ReflectionNamedType|ReflectionUnionType|ReflectionIntersectionType|null
501+
private function createReturnType(MethodNode|Node\PropertyHook|Node\Stmt\Function_|Node\Expr\Closure|Node\Expr\ArrowFunction $node): ReflectionNamedType|ReflectionUnionType|ReflectionIntersectionType|null
502502
{
503503
$returnType = $node->getReturnType();
504504

‎src/Reflection/ReflectionMethod.php

+10-5
Original file line numberDiff line numberDiff line change
@@ -34,37 +34,41 @@ class ReflectionMethod
3434
private int $modifiers;
3535

3636
/**
37+
* @param non-empty-string $name
3738
* @param non-empty-string|null $aliasName
3839
* @param non-empty-string|null $namespace
3940
*/
4041
private function __construct(
4142
private Reflector $reflector,
42-
MethodNode|Node\Stmt\Function_|Node\Expr\Closure|Node\Expr\ArrowFunction $node,
43+
MethodNode|Node\PropertyHook|Node\Stmt\Function_|Node\Expr\Closure|Node\Expr\ArrowFunction $node,
4344
private LocatedSource $locatedSource,
45+
string $name,
4446
private string|null $namespace,
4547
private ReflectionClass $declaringClass,
4648
private ReflectionClass $implementingClass,
4749
private ReflectionClass $currentClass,
4850
private string|null $aliasName,
4951
) {
50-
assert($node instanceof MethodNode);
52+
assert($node instanceof MethodNode || $node instanceof Node\PropertyHook);
5153

52-
$this->name = $node->name->name;
53-
$this->modifiers = $this->computeModifiers($node);
54+
$this->name = $name;
55+
$this->modifiers = $node instanceof MethodNode ? $this->computeModifiers($node) : 0;
5456

5557
$this->fillFromNode($node);
5658
}
5759

5860
/**
5961
* @internal
6062
*
63+
* @param non-empty-string $name
6164
* @param non-empty-string|null $aliasName
6265
* @param non-empty-string|null $namespace
6366
*/
6467
public static function createFromNode(
6568
Reflector $reflector,
66-
MethodNode $node,
69+
MethodNode|Node\PropertyHook $node,
6770
LocatedSource $locatedSource,
71+
string $name,
6872
string|null $namespace,
6973
ReflectionClass $declaringClass,
7074
ReflectionClass $implementingClass,
@@ -75,6 +79,7 @@ public static function createFromNode(
7579
$reflector,
7680
$node,
7781
$locatedSource,
82+
$name,
7883
$namespace,
7984
$declaringClass,
8085
$implementingClass,

0 commit comments

Comments
 (0)