Skip to content

Added new option methodNamingConvention to abstract php class #19794

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

web-mi
Copy link

@web-mi web-mi commented Oct 6, 2024

This PR added new additionalProperty "methodNamingConvention" to handle special cases with mutiple properties like "test" and "_test" which will end in the same getter and setter "getTest". (e.g. Rocket.chat GetApiV1ImList200ResponseImsInner.php)
By setting methodNamingConvenetion to snake_case the method names will be snake_case like "get__test" and "get_test" which is not the php default but solves the problem and makes the generated classes useable without a duplication error.
Also if there are two properties in openapi.yaml like "o_auth_test" and "oauth_test" it will end in a duplicate getter like "getOAuthTest" and "getOauthTest". (e.g. Keycloak RealmRepresentation.php)

This will add a solution for #1633
Its an alternative for #1634 too.

Technical Commitee PHP:
@jebentier, @dkarlovi, @mandrean, @jfastnacht, @ybelenko, @renepardon

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@naetraga
Copy link

naetraga commented Oct 7, 2024

i like it. @web-mi great job 👍

@web-mi web-mi force-pushed the snake_case_php_getter_setter branch from 750d622 to eebd489 Compare October 14, 2024 10:03
@wing328
Copy link
Member

wing328 commented Oct 15, 2024

This PR added new additionalProperty "methodNamingConvention" to handle special cases with mutiple properties like "test" and "_test" which will end in the same getter and setter "getTest"

thanks for the PR

have you tried the operationId mapping option? Would that meet your requirement?

ref: https://github.com/openapitools/openapi-generator/blob/master/docs/customization.md#name-mapping

(this is not to say we won't accept this PR. it's still a good idea to have the option)

@web-mi
Copy link
Author

web-mi commented Oct 15, 2024

Yes i already have seen that option. But i'm automatically generating multiple api clients directly from their resources and i don't wan't to fix it all the time if they change something. :-)
With the snake_case functions i had to fix nothing so i thought it would be a good idea to switch to the snake_case functions. ;-)

@wing328 wing328 modified the milestones: 7.10.0, 7.11.0 Nov 18, 2024
@web-mi web-mi force-pushed the snake_case_php_getter_setter branch from eebd489 to a2162ff Compare December 12, 2024 13:19
@web-mi web-mi requested a review from wing328 December 12, 2024 13:38
@wing328 wing328 modified the milestones: 7.11.0, 7.12.0 Jan 20, 2025
@wing328 wing328 modified the milestones: 7.12.0, 7.13.0 Feb 28, 2025
@wing328 wing328 modified the milestones: 7.13.0, 7.14.0 Apr 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants