mirror of
https://github.com/danog/Valinor.git
synced 2024-12-02 17:48:14 +01:00
b2e810e3ce
Previously, the method `TreeMapper::map` would allow mapping only to an
object. It is now possible to map to any type handled by the library.
It is for instance possible to map to an array of objects:
```php
$objects = (new \CuyZ\Valinor\MapperBuilder())->mapper()->map(
'array<' . SomeClass::class . '>',
[/* … */]
);
```
For simple use-cases, an array shape can be used:
```php
$array = (new \CuyZ\Valinor\MapperBuilder())->mapper()->map(
'array{foo: string, bar: int}',
[/* … */]
);
echo strtolower($array['foo']);
echo $array['bar'] * 2;
```
This new feature changes the possible behaviour of the mapper, meaning
static analysis tools need help to understand the types correctly. An
extension for PHPStan and a plugin for Psalm are now provided and can be
included in a project to automatically increase the type coverage.
63 lines
1.6 KiB
PHP
63 lines
1.6 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace CuyZ\Valinor\QA\PHPStan\Extension;
|
|
|
|
use CuyZ\Valinor\Mapper\TreeMapper;
|
|
use PhpParser\Node\Expr\MethodCall;
|
|
use PHPStan\Analyser\Scope;
|
|
use PHPStan\PhpDoc\TypeStringResolver;
|
|
use PHPStan\Reflection\MethodReflection;
|
|
use PHPStan\Type\Constant\ConstantStringType;
|
|
use PHPStan\Type\DynamicMethodReturnTypeExtension;
|
|
use PHPStan\Type\Generic\GenericClassStringType;
|
|
use PHPStan\Type\MixedType;
|
|
use PHPStan\Type\Type;
|
|
use PHPStan\Type\UnionType;
|
|
|
|
final class TreeMapperPHPStanExtension implements DynamicMethodReturnTypeExtension
|
|
{
|
|
private TypeStringResolver $resolver;
|
|
|
|
public function __construct(TypeStringResolver $resolver)
|
|
{
|
|
$this->resolver = $resolver;
|
|
}
|
|
|
|
public function getClass(): string
|
|
{
|
|
return TreeMapper::class;
|
|
}
|
|
|
|
public function isMethodSupported(MethodReflection $methodReflection): bool
|
|
{
|
|
return $methodReflection->getName() === 'map';
|
|
}
|
|
|
|
public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type
|
|
{
|
|
$argument = $methodCall->getArgs()[0]->value;
|
|
$type = $scope->getType($argument);
|
|
|
|
if ($type instanceof UnionType) {
|
|
return $type->traverse(fn (Type $type) => $this->type($type));
|
|
}
|
|
|
|
return $this->type($type);
|
|
}
|
|
|
|
private function type(Type $type): Type
|
|
{
|
|
if ($type instanceof GenericClassStringType) {
|
|
return $type->getGenericType();
|
|
}
|
|
|
|
if ($type instanceof ConstantStringType) {
|
|
return $this->resolver->resolve($type->getValue());
|
|
}
|
|
|
|
return new MixedType();
|
|
}
|
|
}
|