Skip to content

Added new option methodNamingConvention to abstract php class #19790

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

Closed

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

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.

@web-mi web-mi force-pushed the snake_case_php_getter_setter branch from da99b5d to 54de93e Compare October 6, 2024 10:57
@web-mi web-mi closed this Oct 6, 2024
@web-mi
Copy link
Author

web-mi commented Oct 6, 2024

Sorry found an error in old behaviour because it was going through the variableNamingConvention which already capitalizes some values and results in different getters with default params. Will think about a solution and reopen when solved.

@web-mi
Copy link
Author

web-mi commented Oct 6, 2024

New PR opened:
#19794

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.

1 participant