[PropertyInfo] Added support for extracting type from constructor #25605

lyrixx · 2017-12-26T10:57:31Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	-

javiereguiluz · 2017-12-26T11:19:58Z

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

+    private function extractFromConstructor(string $class, string $property): ?array
+    {
+        try {
+            $class = new \ReflectionClass($class);


Instead of this:

$class = new \ReflectionClass($class); $constructor = $class->getConstructor();

maybe we can use this:

$constructor = (new \ReflectionClass($class))->getConstructor();

javiereguiluz · 2017-12-26T11:20:26Z

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

+            return null;
+        }
+
+        foreach ($constructor->getParameters() as $name => $parameter) {


Is the $name of the foreach different than the $parameter->name used below or we can reuse it?

$name === '$string' (note the leading $).

So I removed the $name assignment. Thanks

javiereguiluz

Thanks for this contribution!

xabbuh · 2017-12-26T21:05:01Z

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

+            return null;
+        }
+
+        if (!$constructor) {


Should we take parent classes into account too?

@lyrixx WDYT? How does phpstorm handle overridden constructors? It could help decide.

I think we should take parents into account.
But I don't know how phpstorm handle that. I don't use it. You should know it ;)
I will check

Just checked, PHP storm is using parent constructor too. I will update the PR

Actually, it's already supported ;) I added a new test case to ensure it works as expected.

I was thinking about this situation:

class a { public $foo; function __construct(string $foo) { $this->foo = $foo; } } class b extends a { function __construct() { parent::__construct('hello'); } }

Ah ok. I have added support for such case with a test case.

I guess the PR is now READY \o/

nicolas-grekas · 2017-12-27T10:42:35Z

@jvasseur please comment when adding a 👎 , we're all curious about all opinions to enlighten decisions.

jvasseur · 2017-12-27T14:07:46Z

Sorry. I'm mostly against this change since having a constructor argument with the same name as a property doesn't necessarily mean it will be saved inside that property. This feels less reliable that using the types from getter/setters and I don't fell fine having this guess inside the same extractor. Maybe putting it inside a separate extractor that could be assigned a to a lower priority.

lyrixx · 2017-12-27T14:50:11Z

@jvasseur I agree with you, and it already have a lower priority. So there are no issue ;)

jvasseur · 2017-12-27T15:17:53Z

@lyrixx it has a lower priority inside the reflection extractor, but it still is the same extractor meaning you can't run another extractor between the accessor and the constructor guess.

lyrixx · 2017-12-27T15:23:30Z

You are right, indeed ;)

But I'm not sure it worth a dedicated extractor. Do you really think it worth this complexity?

jvasseur · 2017-12-27T16:03:27Z

Not necessary I am just thinking this is something that could append but I don't have a real case were it would append.

lyrixx · 2017-12-28T15:03:29Z

👍

nicolas-grekas · 2017-12-28T16:15:18Z

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

+            return array($this->extractFromReflectionType($parameter->getType()));
+        }
+
+        if ($reflectionClass->getParentClass()) {


$parent = to prevent creating two instances of ReflectionClass

dunglas · 2017-12-29T14:05:25Z

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

@@ -100,12 +100,16 @@ public function getProperties($class, array $context = array())
     */
    public function getTypes($class, $property, array $context = array())
    {
-        if ($fromMutator = $this->extractFromMutator($class, $property)) {


Is is really necessary to change this (it will make it harder to merge bug fixes later)?

Nope, it was just done in order to optimize the code. I can revert it if you want

let's revert yes please :)

It's reverted

dunglas · 2017-12-29T14:09:11Z

Shouldn't you also update the getProperties() method to add properties accessible trough the constructor to the list (write only).

Also, if we start supporting this, it would be nice to also support constructors in the PhpDocExtractor (it is more powerful and precise than the ReflectionExtractor).

dunglas · 2017-12-29T14:09:44Z

Regarding @jvasseur's comment, maybe can we add a flag in the constructor to disable this feature?

javiereguiluz · 2017-12-29T14:26:29Z

@dunglas please, let's not complicate things with a constructor flag. I'd like to understand better the problem explained by @jvasseur. Imagine that this is your code:

private /* bool */ $stock;

public function __construct(int $stock)
{
    $this->stock = $stock > 10;
}

The $stock property is private and it doesn't have any getter/setter. The type of the property would be guessed as int instead of bool. Questions: 1) Is this code realistic or an academic example that nobody would use in practice? 2) Which parts of Symfony would stop working because of this wrong guess? Thanks!

nicolas-grekas

apparently this needs to be opt-in, isn't it?

lyrixx · 2018-01-12T16:53:48Z

apparently this needs to be opt-in, isn't it?

What do you mean ?

Taluu · 2018-01-16T12:35:53Z

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

+     *
+     * @return Type[]|null
+     */
+    private function extractFromConstructor(string $class, string $property): ?array


why ?array, and not ?Type ?

Because it returns an array a not a Type

nicolas-grekas

@dunglas, please advise: as is, context option, or constructor flag?

nicolas-grekas · 2018-02-04T17:31:04Z

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

@@ -100,12 +100,16 @@ public function getProperties($class, array $context = array())
     */
    public function getTypes($class, $property, array $context = array())
    {
-        if ($fromMutator = $this->extractFromMutator($class, $property)) {


let's revert yes please :)

dunglas · 2018-02-09T18:57:31Z

Both would be great (we already do that in the serializer component), the constructor flag allowing to set the default value, and the context option taking priority.
If we must choose, I tend to prefer the constructor flag.

lyrixx · 2018-02-16T15:05:08Z

This PR is now ready

dunglas · 2018-02-19T13:45:01Z

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

@@ -107,6 +109,13 @@ public function getTypes($class, $property, array $context = array())
        if ($fromAccessor = $this->extractFromAccessor($class, $property)) {
            return $fromAccessor;
        }
+
+        if (


$context['enable_constructor_extraction'] ?? $this->enableConstructorExtraction?

It's not the same, because if one want to disable it, with your code it will fallback on the enableConstructorExtraction value.

You are right. I fixed it.

dunglas · 2018-02-19T19:25:40Z

Thanks @lyrixx.

…constructor (lyrixx) This PR was merged into the 4.1-dev branch. Discussion ---------- [PropertyInfo] Added support for extracting type from constructor | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Commits ------- adcb25e [PropertyInfo] Added support for extracting type from constructor

carsonbot added Status: Needs Review PropertyInfo Feature labels Dec 26, 2017

lyrixx force-pushed the property-info-constructor branch from 8a421e4 to 4bc0bdb Compare December 26, 2017 10:58

carsonbot added Status: Reviewed and removed Status: Needs Review labels Dec 26, 2017

nicolas-grekas approved these changes Dec 26, 2017

View reviewed changes

javiereguiluz reviewed Dec 26, 2017

View reviewed changes

lyrixx force-pushed the property-info-constructor branch from 4bc0bdb to e1672aa Compare December 26, 2017 12:11

javiereguiluz approved these changes Dec 26, 2017

View reviewed changes

xabbuh reviewed Dec 26, 2017

View reviewed changes

Simperfit approved these changes Dec 27, 2017

View reviewed changes

nicolas-grekas added this to the 4.1 milestone Dec 27, 2017

lyrixx force-pushed the property-info-constructor branch from e1672aa to 4dcdbb2 Compare December 27, 2017 11:23

lyrixx force-pushed the property-info-constructor branch from 4dcdbb2 to 7ba526b Compare December 28, 2017 15:02

nicolas-grekas approved these changes Dec 28, 2017

View reviewed changes

lyrixx force-pushed the property-info-constructor branch from 7ba526b to 2b1c2b3 Compare December 28, 2017 16:45

nicolas-grekas added the Ready label Dec 28, 2017

Simperfit approved these changes Dec 29, 2017

View reviewed changes

dunglas reviewed Dec 29, 2017

View reviewed changes

nicolas-grekas requested changes Jan 7, 2018

View reviewed changes

carsonbot added the Status: Needs Work label Jan 7, 2018

nicolas-grekas removed the Ready label Jan 7, 2018

Taluu reviewed Jan 16, 2018

View reviewed changes

nicolas-grekas reviewed Feb 4, 2018

View reviewed changes

lyrixx force-pushed the property-info-constructor branch from 2b1c2b3 to 264f58f Compare February 9, 2018 17:29

lyrixx force-pushed the property-info-constructor branch from 264f58f to c5b3f45 Compare February 16, 2018 15:04

dunglas requested changes Feb 19, 2018

View reviewed changes

[PropertyInfo] Added support for extracting type from constructor

adcb25e

lyrixx force-pushed the property-info-constructor branch from c5b3f45 to adcb25e Compare February 19, 2018 17:05

carsonbot added Status: Reviewed and removed Status: Needs Work labels Feb 19, 2018

dunglas approved these changes Feb 19, 2018

View reviewed changes

nicolas-grekas approved these changes Feb 19, 2018

View reviewed changes

dunglas merged commit adcb25e into symfony:master Feb 19, 2018

lyrixx deleted the property-info-constructor branch February 20, 2018 10:22

javiereguiluz mentioned this pull request Mar 2, 2018

[PropertyInfo] Added support for extracting type from constructor symfony/symfony-docs#9382

Closed

dunglas mentioned this pull request Apr 3, 2018

Make resource constructor parameters writables api-platform/core#1749

Merged

meyerbaptiste mentioned this pull request Apr 3, 2018

[PropertyInfo] Types should not be extracted from private constructor #26777

Closed

komik966 mentioned this pull request Apr 13, 2018

value object as ApiResource api-platform/core#1843

Closed

7 tasks

fabpot mentioned this pull request May 7, 2018

Release v4.1.0-BETA1 #27181

Merged

dunglas mentioned this pull request May 16, 2018

[Serializer] Allow denormalization of constructor arguments to array of objects #27221

Closed

karser mentioned this pull request Feb 7, 2019

Make constructor argument override the property docblock in PhpDocExtractor #30056

Closed

jvasseur mentioned this pull request Feb 11, 2019

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

Closed

LS05 mentioned this pull request Mar 15, 2019

Improving extracting type from constructor symfony/symfony-docs#10969

Closed

[PropertyInfo] Added support for extracting type from constructor #25605

[PropertyInfo] Added support for extracting type from constructor #25605

Conversation

lyrixx commented Dec 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javiereguiluz Dec 26, 2017 • edited Loading

Choose a reason for hiding this comment

lyrixx Dec 26, 2017 • edited Loading

Choose a reason for hiding this comment

javiereguiluz left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Dec 27, 2017

jvasseur commented Dec 27, 2017

lyrixx commented Dec 27, 2017

jvasseur commented Dec 27, 2017

lyrixx commented Dec 27, 2017

jvasseur commented Dec 27, 2017

lyrixx commented Dec 28, 2017

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

dunglas commented Dec 29, 2017

dunglas commented Dec 29, 2017 • edited Loading

javiereguiluz commented Dec 29, 2017

nicolas-grekas left a comment

Choose a reason for hiding this comment

lyrixx commented Jan 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas commented Feb 9, 2018

lyrixx commented Feb 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas commented Feb 19, 2018

javiereguiluz Dec 26, 2017 •

edited

Loading

lyrixx Dec 26, 2017 •

edited

Loading

dunglas commented Dec 29, 2017 •

edited

Loading

nicolas-grekas left a comment •

edited

Loading