[TypeInfo] Add documentation #19554
[TypeInfo] Add documentation #19554
Conversation
Korbeil
commented
Feb 14, 2024
Korbeil
commented
| Q | A |
|---|---|
| Doc fix? | no |
| New docs? | yes (symfony/symfony#52510) |
| Applies to | 7.1 |
| Fixed tickets | #19497 |
Korbeil
force-pushed
the
feature/type-info-component
branch
from
0e9ac79 to
d4d6b78
Compare
|
|
||
| use Symfony\Component\TypeInfo\Type; | ||
|
|
||
| Type::int(); |
There was a problem hiding this comment.
I don't understand the examples of this block. What are we building? Is this to create something? To check something? How can I use this in a Symfony app? Thanks.
There was a problem hiding this comment.
This is not a component you will use in a Symfony app. This is a component made for other components or for libraries to use.
|
|
||
| // Then resolve types for any subject | ||
| $typeResolver->resolve(new \ReflectionProperty(Dummy::class, 'id')); // returns an "int" Type instance | ||
| $typeResolver->resolve('bool'); // returns a "bool" Type instance |
There was a problem hiding this comment.
The example is not very clear because some reader won't make the connection and don't know that 'bool' here refers to a boolean property of some class.
I think we need to create a simple class first with the needed properties ... and then show the code needed to introspect the type information.
There was a problem hiding this comment.
It's kinda complex because it's not something designed to use "as it is" or only for very specific cases.
I tried to explain a bit better how raw string resolving works and what it is used for (basically phpDoc).
Does it help more to understand ?
|
|
||
| .. note:: | ||
|
|
||
| To support raw string resolving, you need to install ``phpstan/phpdoc-parser`` package. |
There was a problem hiding this comment.
I don't fully understand what "raw string resolving" means here.
There was a problem hiding this comment.
see #19554 (comment) for more details, but "raw string resolving" means you're using the resolver with a string. It is mostly designed to handle phpDoc
carsonbot
changed the title
OskarStark
changed the title
|
Open for finishing the first docs? cc @mtarld |
Sorry for the delay, I made some changes and will try to find time to fix the remaining parts. |
Korbeil
force-pushed
the
feature/type-info-component
branch
from
1b31f40 to
7766204
Compare
|
Hey there, @javiereguiluz any news ? |
javiereguiluz
force-pushed
the
feature/type-info-component
branch
from
7766204 to
b6ffad3
Compare
|
Baptiste, this is now merged. Thanks a lot! I'll open a new issue with some questions related to this doc to see if we can improve it. Thanks! |
