Skip to content

fix(metadata): convert the YAML and XML nativeType of a property when it has a parent #8742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Maxcastel wants to merge 1 commit into
base: 5.0
Choose a base branch
from
Draft

fix(metadata): convert the YAML and XML nativeType of a property when it has a parent #8742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions src/Metadata/Property/Factory/ExtractorPropertyMetadataFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,7 @@ public function create(string $resourceClass, string $property, array $options =

foreach ($propertyMetadata as $key => $value) {
if ('nativeType' === $key && null !== $value) {
if (class_exists(PhpDocParser::class)) {
$apiProperty = $apiProperty->withNativeType((new StringTypeResolver())->resolve($value));

continue;
}

try {
$apiProperty = $apiProperty->withNativeType(Type::builtin($value));
} catch (\ValueError) {
throw new RuntimeException(\sprintf('Cannot create a type from "%s". Try running "composer require phpstan/phpdoc-parser" to support all types.', $value));
}
$apiProperty = $apiProperty->withNativeType($this->createNativeType($value));

continue;
}
Expand Down Expand Up @@ -106,13 +96,30 @@ private function update(ApiProperty $propertyMetadata, array $metadata): ApiProp
{
foreach (get_class_methods(ApiProperty::class) as $method) {
if (preg_match('/^(?:get|is)(.*)/', (string) $method, $matches) && null !== ($val = $metadata[lcfirst($matches[1])] ?? null) && method_exists($propertyMetadata, "with{$matches[1]}")) {
if ('NativeType' === $matches[1]) {
$val = $this->createNativeType($val);
}

$propertyMetadata = $propertyMetadata->{"with{$matches[1]}"}($val);
}
}

return $propertyMetadata;
}

private function createNativeType(string $type): Type
{
if (class_exists(PhpDocParser::class)) {
return (new StringTypeResolver())->resolve($type);
}

try {
return Type::builtin($type);
} catch (\ValueError) {
throw new RuntimeException(\sprintf('Cannot create a type from "%s". Try running "composer require phpstan/phpdoc-parser" to support all types.', $type));
}
}

private function handleUserDefinedSchema(ApiProperty $propertyMetadata): ApiProperty
{
// can't know later if the schema has been defined by the user or by API Platform
Expand Down
22 changes: 22 additions & 0 deletions src/Metadata/Tests/Property/Factory/ExtractorPropertyMetadataFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@

namespace ApiPlatform\Metadata\Tests\Property\Factory;

use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\Extractor\PropertyExtractorInterface;
use ApiPlatform\Metadata\Property\Factory\ExtractorPropertyMetadataFactory;
use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\Tests\Fixtures\ApiResource\Comment;
use PHPUnit\Framework\TestCase;
use Prophecy\PhpUnit\ProphecyTrait;
Expand All @@ -39,4 +41,24 @@ public function testCreateVirtualPropertyFromExtractor(): void

self::assertSame('user.isAdmin() === true', $metadata->getSecurity());
}

public function testCreateNativeTypeWithDecoratedFactory(): void
{
$extractor = $this->createStub(PropertyExtractorInterface::class);
$extractor->method('getProperties')->willReturn([
Comment::class => [
'id' => [
'nativeType' => 'int',
],
],
]);

$decorated = $this->createStub(PropertyMetadataFactoryInterface::class);
$decorated->method('create')->willReturn(new ApiProperty(readable: true));

$metadata = (new ExtractorPropertyMetadataFactory($extractor, $decorated))->create(Comment::class, 'id');

self::assertSame('int', (string) $metadata->getNativeType());
self::assertTrue($metadata->isReadable());
}
}
Loading