Created by: 77web
fixed Enum usage in PHP APIClients.
I tested actual API requests with this new EnumInterface, which performs API requests successfully
before
// code which causes error in static analysis
$someModel = new SomeModel();
$someModel->setSomeEnumField(SomeEnum::VALUE_A); // error, setter has type declaration in phpdoc with "SomeEnum" , SomeEnum::VALUE_A is not a "SomeEnum" instance, but just a string in php
// code to avoid error
$someModel = new SomeModel([
'some_enum_field' => SomeEnum::VALUE_A,
]);
after
$someModel = new SomeModel();
$someModel->setSomeEnumField(new SomeEnum(SomeEnum::VALUE_A));
note: php8.1 has native Enum feature and it allows code like this.
$someModel = new SomeModel();
$someModel->setSomeEnumField(SomeEnum::VALUE_A);
But, many projects have not yet updated their environments to php8.1.
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
./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.3.0),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.