symfony/symfony-docsPublic

NotificationsYou must be signed in to change notification settings
Fork5.2k
Star2.3k

[TypeInfo] Add documentation#19554

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

javiereguiluz merged 1 commit intosymfony:7.1fromKorbeil:feature/type-info-component

Jul 2, 2024

Merged

[TypeInfo] Add documentation#19554

javiereguiluz merged 1 commit intosymfony:7.1fromKorbeil:feature/type-info-component

Jul 2, 2024

Conversation

Copy link

Contributor

Korbeil commentedFeb 14, 2024

Q	A
Doc fix?	no
New docs?	yes (symfony/symfony#52510)
Applies to	7.1
Fixed tickets	#19497

carsonbot added the Status: Needs Review label

Feb 14, 2024

carsonbot added this to the7.1 milestone

Feb 14, 2024

Korbeil force-pushed thefeature/type-info-component branch from0e9ac79 tod4d6b78Compare

February 14, 2024 08:17

javiereguiluz reviewed

Feb 19, 2024

View reviewed changes

Copy link

Member

javiereguiluz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Baptiste, thanks for bootstrapping these docs.

I left some comments in some sections that I found a bit confusing or lacking so we can iterate over them. Thanks!

components/type_info.rst OutdatedShow resolvedHide resolved

components/type_info.rst


		use Symfony\Component\TypeInfo\Type;

		Type::int();

Copy link

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link

ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

components/type_info.rst


		// 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

Copy link

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link

ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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 ?

components/type_info.rst


		.. note::

		To support raw string resolving, you need to install ``phpstan/phpdoc-parser`` package.

Copy link

Member

javiereguiluzFeb 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I don't fully understand what "raw string resolving" means here.

Copy link

ContributorAuthor

KorbeilMay 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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