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

[PHP] Use a valid php type for maps #8718

Merged
merged 2 commits into from
Feb 21, 2021

Conversation

neclimdul
Copy link
Contributor

This pull request aligns the map types to native array types.

It does this in two steps to show the impact of the change.

  1. It maps map to the native array type.
  2. It adjusts the syntax to match that expected by psalm, phpdoc, and IDE's that parse phpdoc.

@jebentier @dkarlovi @mandrean @jfastnacht @ackintosh @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/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, 5.1.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@ybelenko ybelenko changed the title Use a valid php type for maps [PHP] Use a valid php type for maps Feb 16, 2021
Align map array format to that expected by phpdoc and associated tools.
@neclimdul
Copy link
Contributor Author

travis failure looks to be trouble talking to npm. Skim of the results seem to show all php tests passing.

@@ -278,7 +278,7 @@ class ObjectSerializer
return $values;
}

if (substr($class, 0, 4) === 'map[') { // for associative array e.g. map[string,int]
if (preg_match('/^(array<|map\[)/', $class)) { // for associative array e.g. array<string,int>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Most of the changes are documentation. There could be no code instances since map was not a valid keyword/type.

This is kinda the glue for what should be the only technical change. When deserializing this handles but the new generated value and the old map value in case it was being references in some code.

@neclimdul
Copy link
Contributor Author

I saw some comments that started dealing with this problem by injecting psalm/phpstan comments into the models. This shouldn't be needed anymore and can be removed after this change since it addresses the problem everywhere maps show up.

@wing328
Copy link
Member

wing328 commented Feb 21, 2021

Travis CI failure not related to this change.

Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

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

LGTM but I've not tested it locally

@wing328 wing328 merged commit f3c164d into OpenAPITools:master Feb 21, 2021
@wing328 wing328 added this to the 5.1.0 milestone Mar 16, 2021
@wing328
Copy link
Member

wing328 commented Mar 22, 2021

@neclimdul thanks for the PR, which has been included in the v5.1.0 release: https://twitter.com/oas_generator/status/1373636654024380423

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.

None yet

3 participants