Skip to content
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

[FEATURE] Make Fully Qualified name available in members node. #41

Merged
merged 2 commits into from
Mar 25, 2024

Conversation

linawolf
Copy link
Member

@linawolf linawolf commented Mar 24, 2024

This is used to suggest a rst reference snippet in the render-guides.

I can then offer the following code in the suggest wizzard:

:php:method:`somemanual:\LibraryName\LibraryClassFinal::firstmethod`

Instead of something like this:

:php:method:`somemanual:libraryname-libraryclassfinal-firstmethod`

depends on #42

This is used to suggest a rst reference snippet in the render-guides.

I can then offer the following code in the suggest wizzard:

:php:method:`somemanual:\LibraryName\LibraryClassFinal::firstmethod`

Instead of something like this:

:php:method:`somemanual:libraryname-libraryclassfinal-firstmethod`
@linawolf linawolf self-assigned this Mar 24, 2024
Whitespace handling changed in the guides, therefore
our integration tests need to be updated for whitespace.
linawolf added a commit to TYPO3-Documentation/render-guides that referenced this pull request Mar 24, 2024
For nicer links to members (methods, constants etc) we need TYPO3-Documentation/guides-php-domain#41
Copy link
Contributor

@garvinhicking garvinhicking left a comment

Choose a reason for hiding this comment

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

I'm not the biggest trait fan, so just a question that I can better understand the use case here. Why wouldn't we add the method to the SubDirective class? If I saw right, everything that uses the component also inherits from there? And else we might want to create a new "ComponentSubDirective" class if not every SubDirective should receive the method?

@linawolf
Copy link
Member Author

The Subdirective is in the guides, we cant change it here. We could make another level of inheritance to avoid the trait. My understanding of Traits was, however that they were created to avoid large chains of inheritance....

Copy link
Contributor

@garvinhicking garvinhicking left a comment

Choose a reason for hiding this comment

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

Thanks for stating that intent. I'd prefer inheritance over composition, but I don't want to impose, and I'm good with doing it the way you propose. ☺️

@linawolf linawolf merged commit 77a6e5c into main Mar 25, 2024
3 checks passed
@linawolf linawolf deleted the feature/fqn-for-members branch March 25, 2024 04:50
linawolf added a commit to TYPO3-Documentation/render-guides that referenced this pull request Mar 30, 2024
For nicer links to members (methods, constants etc) we need TYPO3-Documentation/guides-php-domain#41
linawolf added a commit to TYPO3-Documentation/render-guides that referenced this pull request Mar 31, 2024
For nicer links to members (methods, constants etc) we need TYPO3-Documentation/guides-php-domain#41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants