Add Symfony Uid support #3715
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <?xml version="1.0" ?> | ||
|
|
||
| <container xmlns="http://symfony.com/schema/dic/services" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd"> | ||
|
|
||
| <services> | ||
| <service id="api_platform.identifier.symfony_ulid_normalizer" class="ApiPlatform\Core\Bridge\Symfony\Identifier\Normalizer\UlidNormalizer" public="false"> | ||
|
There was a problem hiding this comment. Why not make the two Normalizers in one? |
||
| <tag name="api_platform.identifier.denormalizer" /> | ||
| </service> | ||
|
|
||
| <service id="api_platform.identifier.symfony_uuid_normalizer" class="ApiPlatform\Core\Bridge\Symfony\Identifier\Normalizer\UuidNormalizer" public="false"> | ||
| <tag name="api_platform.identifier.denormalizer" /> | ||
| </service> | ||
| </services> | ||
| </container> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the API Platform project. | ||
| * | ||
| * (c) Kévin Dunglas <[email protected]> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace ApiPlatform\Core\Bridge\Symfony\Identifier\Normalizer; | ||
|
|
||
| use ApiPlatform\Core\Exception\InvalidIdentifierException; | ||
| use Symfony\Component\Serializer\Normalizer\DenormalizerInterface; | ||
| use Symfony\Component\Uid\Ulid; | ||
|
|
||
| /** | ||
| * Denormalizes an ULID string to an instance of Symfony\Component\Uid\Ulid. | ||
| */ | ||
| final class UlidNormalizer implements DenormalizerInterface | ||
| { | ||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function denormalize($data, $class, $format = null, array $context = []) | ||
| { | ||
| try { | ||
| return Ulid::fromString($data); | ||
| } catch (\InvalidArgumentException $e) { | ||
| throw new InvalidIdentifierException($e->getMessage(), $e->getCode(), $e); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function supportsDenormalization($data, $type, $format = null) | ||
| { | ||
| return \is_string($data) && is_a($type, Ulid::class, true); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the API Platform project. | ||
| * | ||
| * (c) Kévin Dunglas <[email protected]> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace ApiPlatform\Core\Bridge\Symfony\Identifier\Normalizer; | ||
|
|
||
| use ApiPlatform\Core\Exception\InvalidIdentifierException; | ||
| use Symfony\Component\Serializer\Normalizer\DenormalizerInterface; | ||
| use Symfony\Component\Uid\Uuid; | ||
|
|
||
| /** | ||
| * Denormalizes an UUID string to an instance of Symfony\Component\Uid\Uuid. | ||
| */ | ||
| final class UuidNormalizer implements DenormalizerInterface | ||
| { | ||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function denormalize($data, $class, $format = null, array $context = []) | ||
| { | ||
| try { | ||
| return Uuid::fromString($data); | ||
| } catch (\InvalidArgumentException $e) { | ||
| throw new InvalidIdentifierException($e->getMessage(), $e->getCode(), $e); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function supportsDenormalization($data, $type, $format = null) | ||
| { | ||
| return \is_string($data) && is_a($type, Uuid::class, true); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,8 @@ | |
| use ApiPlatform\Core\Util\ResourceClassInfoTrait; | ||
| use Ramsey\Uuid\UuidInterface; | ||
| use Symfony\Component\PropertyInfo\Type; | ||
| use Symfony\Component\Uid\Ulid; | ||
| use Symfony\Component\Uid\Uuid; | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
|
|
@@ -106,12 +108,18 @@ private function getClassType(?string $className, string $format, ?bool $readabl | |
| 'format' => 'duration', | ||
| ]; | ||
| } | ||
| if (is_a($className, UuidInterface::class, true) || is_a($className, Uuid::class, true)) { | ||
| return [ | ||
| 'type' => 'string', | ||
| 'format' => 'uuid', | ||
| ]; | ||
| } | ||
| if (is_a($className, Ulid::class, true)) { | ||
| return [ | ||
| 'type' => 'string', | ||
| 'format' => 'ulid', | ||
| ]; | ||
| } | ||
|
|
||
| // Skip if $schema is null (filters only support basic types) | ||
| if (null === $schema) { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -113,6 +113,7 @@ | |
| use Symfony\Component\DependencyInjection\Reference; | ||
| use Symfony\Component\HttpFoundation\Response; | ||
| use Symfony\Component\Serializer\Exception\ExceptionInterface; | ||
| use Symfony\Component\Uid\AbstractUid; | ||
|
|
||
| /** | ||
| * @group resource-hog | ||
|
|
@@ -986,6 +987,11 @@ private function getPartialContainerBuilderProphecy($configuration = null) | |
| 'api_platform.subresource_operation_factory.cached', | ||
| ]; | ||
|
|
||
| if (class_exists(AbstractUid::class)) { | ||
| $definitions[] = 'api_platform.identifier.symfony_ulid_normalizer'; | ||
| $definitions[] = 'api_platform.identifier.symfony_uuid_normalizer'; | ||
| } | ||
|
|
||
| foreach ($definitions as $definition) { | ||
| $containerBuilderProphecy->setDefinition($definition, Argument::type(Definition::class))->shouldBeCalled(); | ||
| } | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.