[PropertyInfo] ConstructorExtractor which has higher priority than PhpDocExtractor and ReflectionExtractor #30128

karser · 2019-02-09T21:28:04Z

Q	A
Branch?	4.2
Bug fix?	yes
New feature?	no
BC breaks?	hopefully no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#30053
License	MIT

The discussion is in previous PR #30056
In short, when using PhpDocExtractor, it ignores the constructor argument type, although argument types from the constructor are the only types that are valid for the class instantiation.

This PR adds a separate extractor - ConstructorExtractor which is called first (-999) and it attempts to extract the type from constructor only, either from PhpDoc or using reflection.
I added getTypesFromConstructor to PhpDocExtractor and ReflectionExtractor - they implement ConstructorArgumentTypeExtractorInterface interface. ConstructorExtractor aggregates those extractors using compiler pass.

So the flow of control looks like this:

PropertyInfoExtractor::getTypes:
    - ConstructorExtractor::getTypes
        - PhpDocExtractor::getTypesFromConstructor
        - ReflectionExtractor::getTypesFromConstructor
    - PhpDocExtractor::getTypes
    - ReflectionExtractor::getTypes

…ctor and ReflectionExtractor

OskarStark · 2019-02-10T17:25:43Z

src/Symfony/Component/PropertyInfo/Extractor/PhpDocExtractor.php

+     *
+     * @return DocBlock
+     */
+    private function filterDocBlockParams(DocBlock $docBlock, $allowedParam)


You should use type hints and return types wherever possible as this is for 4.2 and new code if I am right

@OskarStark I applied the type hints in #30335

jvasseur · 2019-02-10T20:30:13Z

The problem with this solution is that by replacing the property types with the ones from the constructor we will break updating the entity with the setter (when using object_to_populate for example) because the type will be wrong there instead.

I think the only way to solve this problem without breaking anything would be to hold constructor argument metadata separately from property metadata. Maybe we could go with the ConstructorArgumentTypeExtractorInterface interface introduced in this PR but instead of using a ConstructorExtractor we could call the getTypesFromConstructor directly from the denormalizer.

karser · 2019-02-11T10:41:51Z

@jvasseur
How should we approach these controversial cases?
We could restrict inferring the property type from constructor to the original case only (see #30053) where the property is private and doesn't have getter/setter.
If we did that, would it still break updating the entity with the setter?

jvasseur · 2019-02-11T10:57:27Z

@karser I think we souldn't infer the property type from constructor arguments at all, this would leave the property type guessing only to for properties (and setter/getter) and provide a completely separate API for getting constructor types.

I was originaly not sure about guessing property types from constructor arguments (#25605) but didn't have an example ready to be sure if there would be a problem or not, I guess now we have one.

fabpot · 2019-02-21T10:15:39Z

As discussed in the PR for 3.4, this is a new feature and as such it should target master.

OskarStark · 2019-02-21T11:20:38Z

src/Symfony/Component/PropertyInfo/Extractor/ConstructorArgumentTypeExtractorInterface.php

+     *
+     * @return Type[]|null
+     */
+    public function getTypesFromConstructor($class, $property);


you should add typehints and return type

OskarStark · 2019-02-21T11:21:44Z

src/Symfony/Component/PropertyInfo/Extractor/ReflectionExtractor.php

+     *
+     * @return \ReflectionParameter|null
+     */
+    private function getReflectionParameterFromConstructor($property, \ReflectionMethod $reflectionConstructor)


Suggested change

private function getReflectionParameterFromConstructor($property, \ReflectionMethod $reflectionConstructor)

private function getReflectionParameterFromConstructor(string $property, \ReflectionMethod $reflectionConstructor): ?\ReflectionParameter

OskarStark · 2019-02-21T11:22:26Z

src/Symfony/Component/PropertyInfo/Tests/Extractor/ConstructorExtractorTest.php

+
+    public function testGetTypes()
+    {
+        $this->assertEquals([new Type(Type::BUILTIN_TYPE_STRING)], $this->extractor->getTypes('Foo', 'bar', []));


Can you use assertSame() here?

I can't, assertSame asserts that two variables reference the same object.

OskarStark · 2019-02-21T11:23:19Z

src/Symfony/Component/PropertyInfo/Tests/Fixtures/ConstructorDummy.php

+     * @param int                $date       Timestamp
+     * @param \DateTimeInterface $dateObject
+     */
+    public function __construct(\DateTimeZone $timezone, $date, $dateObject, \DateTime $dateTime)


Suggested change

public function __construct(\DateTimeZone $timezone, $date, $dateObject, \DateTime $dateTime)

public function __construct(\DateTimeZone $timezone, int $date, \DateTimeInterface $dateObject, \DateTime $dateTime)

but $dateObject isn't used´ .... 🤔

@OskarStark That's on purpose, they are used for testing phpdoc types extraction from constructor args even if no such property exists.

karser · 2019-02-21T16:38:34Z

closing this in favor of #30335

…riority than PhpDocExtractor and ReflectionExtractor (karser) This PR was merged into the 5.2-dev branch. Discussion ---------- [PropertyInfo] ConstructorExtractor which has higher priority than PhpDocExtractor and ReflectionExtractor | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | yes | BC breaks? | hopefully no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #30053 | License | MIT Supersedes #30056 #30128 In short, when using PhpDocExtractor, it ignores the constructor argument type, although `argument types from the constructor are the only types that are valid for the class instantiation`. This PR adds a separate extractor - `ConstructorExtractor` which is called first (-999) and it attempts to extract the type from constructor only, either from PhpDoc or using reflection. I added `getTypesFromConstructor` to `PhpDocExtractor` and `ReflectionExtractor` - they implement `ConstructorArgumentTypeExtractorInterface` interface. `ConstructorExtractor` aggregates those extractors using compiler pass. So the flow of control looks like this: ``` PropertyInfoExtractor::getTypes: - ConstructorExtractor::getTypes - PhpDocExtractor::getTypesFromConstructor - ReflectionExtractor::getTypesFromConstructor - PhpDocExtractor::getTypes - ReflectionExtractor::getTypes ``` Commits ------- 5049e25 Added ConstructorExtractor which has higher priority than PhpDocExtractor and ReflectionExtractor

Added ConstructorExtractor which has higher priority than PhpDocExtra…

51a14b1

…ctor and ReflectionExtractor

carsonbot added Status: Needs Review PropertyInfo Bug labels Feb 9, 2019

karser added 2 commits February 9, 2019 23:29

fabbot.io compliance

fd1689e

fix supported PropertyInfo component version constraints

3efc0c6

nicolas-grekas added this to the 4.2 milestone Feb 10, 2019

OskarStark reviewed Feb 10, 2019

View reviewed changes

karser mentioned this pull request Feb 21, 2019

Make constructor argument override the property docblock in PhpDocExtractor #30056

Closed

OskarStark reviewed Feb 21, 2019

View reviewed changes

karser mentioned this pull request Feb 21, 2019

[PropertyInfo] ConstructorExtractor which has higher priority than PhpDocExtractor and ReflectionExtractor #30335

Merged

karser closed this Feb 21, 2019

karser deleted the 4-2-constructor-extractor branch February 21, 2019 16:49

HypeMC mentioned this pull request May 16, 2023

[FrameworkBundle][PropertyInfo] Wire the ConstructorExtractor class #50334

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PropertyInfo] ConstructorExtractor which has higher priority than PhpDocExtractor and ReflectionExtractor #30128

[PropertyInfo] ConstructorExtractor which has higher priority than PhpDocExtractor and ReflectionExtractor #30128

karser commented Feb 9, 2019

OskarStark Feb 10, 2019

karser Feb 21, 2019

jvasseur commented Feb 10, 2019

karser commented Feb 11, 2019

jvasseur commented Feb 11, 2019

fabpot commented Feb 21, 2019

OskarStark Feb 21, 2019

OskarStark Feb 21, 2019

OskarStark Feb 21, 2019

karser Feb 21, 2019

OskarStark Feb 21, 2019

OskarStark Feb 21, 2019

karser Feb 21, 2019 •

edited

karser commented Feb 21, 2019

	private function getReflectionParameterFromConstructor($property, \ReflectionMethod $reflectionConstructor)
	private function getReflectionParameterFromConstructor(string $property, \ReflectionMethod $reflectionConstructor): ?\ReflectionParameter

	public function __construct(\DateTimeZone $timezone, $date, $dateObject, \DateTime $dateTime)
	public function __construct(\DateTimeZone $timezone, int $date, \DateTimeInterface $dateObject, \DateTime $dateTime)

[PropertyInfo] ConstructorExtractor which has higher priority than PhpDocExtractor and ReflectionExtractor #30128

[PropertyInfo] ConstructorExtractor which has higher priority than PhpDocExtractor and ReflectionExtractor #30128

Conversation

karser commented Feb 9, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jvasseur commented Feb 10, 2019

karser commented Feb 11, 2019

jvasseur commented Feb 11, 2019

fabpot commented Feb 21, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

karser Feb 21, 2019 • edited

Choose a reason for hiding this comment

karser commented Feb 21, 2019

karser Feb 21, 2019 •

edited