-
-
Notifications
You must be signed in to change notification settings - Fork 364
[LiveComponent] Fix PropertyTypeExtractorInterface::getTypes() deprecation, use TypeInfo ^7.2 Type
#2607
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.
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
Merged
Merged
[LiveComponent] Fix PropertyTypeExtractorInterface::getTypes() deprecation, use TypeInfo ^7.2 Type
#2607
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
Large diffs are not rendered by default.
Oops, something went wrong.
148 changes: 148 additions & 0 deletions
148
src/LiveComponent/src/Metadata/LegacyLivePropMetadata.php
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,148 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\UX\LiveComponent\Metadata; | ||
|
|
||
| use Symfony\Component\PropertyInfo\Type; | ||
| use Symfony\UX\LiveComponent\Attribute\LiveProp; | ||
|
|
||
| /** | ||
| * @author Kevin Bond <kevinbond@gmail.com> | ||
| * | ||
| * @internal | ||
| */ | ||
| final class LegacyLivePropMetadata | ||
| { | ||
| public function __construct( | ||
| private string $name, | ||
| private LiveProp $liveProp, | ||
| private ?string $typeName, | ||
| private bool $isBuiltIn, | ||
| private bool $allowsNull, | ||
| private ?Type $collectionValueType, | ||
| ) { | ||
| } | ||
|
|
||
| public function getName(): string | ||
| { | ||
| return $this->name; | ||
| } | ||
|
|
||
| public function getType(): ?string | ||
| { | ||
| return $this->typeName; | ||
| } | ||
|
|
||
| public function isBuiltIn(): bool | ||
| { | ||
| return $this->isBuiltIn; | ||
| } | ||
|
|
||
| public function allowsNull(): bool | ||
| { | ||
| return $this->allowsNull; | ||
| } | ||
|
|
||
| public function urlMapping(): ?UrlMapping | ||
| { | ||
| return $this->liveProp->url() ?: null; | ||
| } | ||
|
|
||
| public function calculateFieldName(object $component, string $fallback): string | ||
| { | ||
| return $this->liveProp->calculateFieldName($component, $fallback); | ||
| } | ||
|
|
||
| /** | ||
| * @return array<string> | ||
| */ | ||
| public function writablePaths(): array | ||
| { | ||
| return $this->liveProp->writablePaths(); | ||
| } | ||
|
|
||
| public function hydrateMethod(): ?string | ||
| { | ||
| return $this->liveProp->hydrateMethod(); | ||
| } | ||
|
|
||
| public function dehydrateMethod(): ?string | ||
| { | ||
| return $this->liveProp->dehydrateMethod(); | ||
| } | ||
|
|
||
| public function isIdentityWritable(): bool | ||
| { | ||
| return $this->liveProp->isIdentityWritable(); | ||
| } | ||
|
|
||
| public function acceptUpdatesFromParent(): bool | ||
| { | ||
| return $this->liveProp->acceptUpdatesFromParent(); | ||
| } | ||
|
|
||
| public function useSerializerForHydration(): bool | ||
| { | ||
| return $this->liveProp->useSerializerForHydration(); | ||
| } | ||
|
|
||
| public function serializationContext(): array | ||
| { | ||
| return $this->liveProp->serializationContext(); | ||
| } | ||
|
|
||
| public function collectionValueType(): ?Type | ||
| { | ||
| return $this->collectionValueType; | ||
| } | ||
|
|
||
| public function getFormat(): ?string | ||
| { | ||
| return $this->liveProp->format(); | ||
| } | ||
|
|
||
| public function onUpdated(): string|array|null | ||
| { | ||
| return $this->liveProp->onUpdated(); | ||
| } | ||
|
|
||
| public function hasModifier(): bool | ||
| { | ||
| return null !== $this->liveProp->modifier(); | ||
| } | ||
|
|
||
| /** | ||
| * Applies a modifier specified in LiveProp attribute. | ||
| * | ||
| * If a modifier is specified, a modified clone is returned. | ||
| * Otherwise, the metadata is returned as it is. | ||
| */ | ||
| public function withModifier(object $component): self | ||
| { | ||
| if (null === ($modifier = $this->liveProp->modifier())) { | ||
| return $this; | ||
| } | ||
|
|
||
| if (!method_exists($component, $modifier)) { | ||
| throw new \LogicException(\sprintf('Method "%s::%s()" given in LiveProp "modifier" does not exist.', $component::class, $modifier)); | ||
| } | ||
|
|
||
| $modifiedLiveProp = $component->{$modifier}($this->liveProp, $this->getName()); | ||
| if (!$modifiedLiveProp instanceof LiveProp) { | ||
| throw new \LogicException(\sprintf('Method "%s::%s()" should return an instance of "%s" (given: "%s").', $component::class, $modifier, LiveProp::class, get_debug_type($modifiedLiveProp))); | ||
| } | ||
|
|
||
| $clone = clone $this; | ||
| $clone->liveProp = $modifiedLiveProp; | ||
|
|
||
| return $clone; | ||
| } | ||
| } |
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
Oops, something went wrong.
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.
Method
$this->propertyTypeExtractor->getTypes()triggers a deprecation explaining to usegetType(), which is a bit useless for the end-user sincegetTypes()is internally called by us.At this point, can we add a deprecation for PHP 8.2+ to tell the user to install
symfony/property-info:^7.1(which implementsgetType()and ships withsymfony/type-info)?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.
Hum, I don't see how we can do it correctly, the deprecation on
getTypes()has been added insymfony/property-info:^7.3.I guess the current deprecation and a changelog entry could be enough
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.
changelog entry added