Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[PHP] Add support to nullable (based on #3493) #12794

Merged

Conversation

thomasphansen
Copy link
Contributor

This is basically PR #3493, rebased, adjusted to the latest code and with some bug fixes and code modernization. @githubERIK, the author of the original PR, said he doesn't plan to continue with that (#3493 (comment)), but we have been using his code in our fork for more than 2 years, with no issues! 😄

His biggest concert was support for openapi 2.0. But this is not a problem at all: OpenAPIGenerator is setting isNullable to true if 'x-nullable' is defined in the swagger file, which means, this code works OOTB with openapi 2.0, provided that x-nullable is properly set.

The most important changes to the original code are:

  • model_generic.mustache, method isNullable(): changed to use self::openAPINullables() method instead of the property itself. This is a bugfix: if we don't do this, parent properties will not be checked.
  • model_generic.mustache, methods getOpenAPINullablesSetToNull() and setIfExists(): changed to private, since they are internal to the model class.
  • model_generic.mustache, method openAPINullables(): changed to protected, since it is only used within class and parent scope.
  • model_generic.mustache, method setIfExists(): changed to return void, as it is used only internally and its return is never used.
  • included isNullable() and isNullableSetToNull() to ModelInterface.mustache, which didn't exist when the original PR was presented
  • modernized PR code (null coalesce operator, return types, missing types for properties)

If the original author prefers, I can present these changes as a patch to his own PR, or he can add me to his branch so that I can merge them myself. The only important thing for me is to see the feature in OpenAPIGenerator base code, as a) it works very well! 😄 and b) this would help us moving away from using a fork 😉

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/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the [technical committee]
    @jebentier, @dkarlovi, @mandrean, @jfastnacht, @ybelenko, @renepardon

@thomasphansen thomasphansen changed the title Th php add support to nullable [PHP] Add support to nullable (based on #3493) Jul 8, 2022
@wing328 wing328 added this to the 6.1.0 milestone Jul 11, 2022
@wing328
Copy link
Member

wing328 commented Jul 11, 2022

@wing328
Copy link
Member

wing328 commented Jul 11, 2022

@thomasphansen thanks for the PR. Let's move ahead with this change.

@wing328 wing328 merged commit cd48db4 into OpenAPITools:master Jul 11, 2022
@wing328 wing328 mentioned this pull request Jul 11, 2022
4 tasks
@thomasphansen thomasphansen deleted the th_php_add_support_to_nullable branch July 13, 2022 08:22
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants