-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
[php-laravel] Use baseName instead of paramName for request lookup & validation keys
#24400
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
Merged
wing328
merged 2 commits into
OpenAPITools:master
from
holkerveen:fix/php-laravel-basename-request-lookups
Jul 24, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
modules/openapi-generator/src/main/resources/php-laravel/api_validation.mustache
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
72 changes: 72 additions & 0 deletions
72
...rator/src/test/java/org/openapitools/codegen/php/laravel/PhpLaravelServerCodegenTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| package org.openapitools.codegen.php.laravel; | ||
|
|
||
| import org.openapitools.codegen.ClientOptInput; | ||
| import org.openapitools.codegen.DefaultGenerator; | ||
| import org.openapitools.codegen.TestUtils; | ||
| import org.openapitools.codegen.config.CodegenConfigurator; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| import java.io.File; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| public class PhpLaravelServerCodegenTest { | ||
|
|
||
| /** | ||
| * Parameters whose spec (wire) name is not already a valid camelCase PHP identifier must be read | ||
| * from the request and validated under the wire name ({@code baseName}), not under the sanitized | ||
| * PHP variable name ({@code paramName}). Otherwise the generated controller reads the wrong key | ||
| * and the value is always null. | ||
| */ | ||
| @Test | ||
| public void shouldUseWireNameForRequestLookupsAndValidationKeys() throws Exception { | ||
| Map<String, Object> properties = new HashMap<>(); | ||
|
|
||
| File output = Files.createTempDirectory("test").toFile(); | ||
|
|
||
| final CodegenConfigurator configurator = new CodegenConfigurator() | ||
| .setGeneratorName("php-laravel") | ||
| .setAdditionalProperties(properties) | ||
| .setInputSpec("src/test/resources/3_0/php-laravel/petstore-with-fake-endpoints-models-for-testing.yaml") | ||
| .setOutputDir(output.getAbsolutePath().replace("\\", "/")); | ||
|
|
||
| final ClientOptInput clientOptInput = configurator.toClientOptInput(); | ||
| DefaultGenerator generator = new DefaultGenerator(); | ||
| List<File> files = generator.opts(clientOptInput).generate(); | ||
|
|
||
| TestUtils.ensureContainsFile(files, output, "Http/Controllers/FakeController.php"); | ||
| TestUtils.ensureContainsFile(files, output, "Http/Controllers/StoreController.php"); | ||
| TestUtils.ensureContainsFile(files, output, "Http/Controllers/UserController.php"); | ||
|
|
||
| Path fakeController = files.stream().filter(f -> f.getName().equals("FakeController.php")).findFirst().orElseThrow().toPath(); | ||
|
|
||
| // request accessors use the wire name (snake_case) while the local variable keeps the sanitized name | ||
| TestUtils.assertFileContains(fakeController, "$filterClientName = $request->string('filter_client_name')->value();"); | ||
| TestUtils.assertFileContains(fakeController, "$filterUserIds = $request->get('filter_user_ids');"); | ||
| TestUtils.assertFileContains(fakeController, "$clientId = $request->integer('client_id');"); | ||
|
|
||
| // validation rule keys must match $request->all(), i.e. the wire name | ||
| TestUtils.assertFileContains(fakeController, "'filter_client_name' => ["); | ||
| TestUtils.assertFileContains(fakeController, "'filter_user_ids' => ["); | ||
| TestUtils.assertFileContains(fakeController, "'client_id' => ["); | ||
|
|
||
| // the buggy behaviour (reading under the sanitized identifier) must not reappear | ||
| TestUtils.assertFileNotContains(fakeController, "$request->string('filterClientName')"); | ||
| TestUtils.assertFileNotContains(fakeController, "$request->get('filterUserIds')"); | ||
| TestUtils.assertFileNotContains(fakeController, "$request->integer('clientId')"); | ||
|
|
||
| // path parameters: the merged validation key and the rule key both use the wire name | ||
| Path storeController = files.stream().filter(f -> f.getName().equals("StoreController.php")).findFirst().orElseThrow().toPath(); | ||
| TestUtils.assertFileContains(storeController, "'order_id' => $orderId,"); | ||
| TestUtils.assertFileContains(storeController, "'order_id' => ["); | ||
|
|
||
| // body parameters are out of scope and must stay byte-identical: no wire-name substitution for the request body | ||
| Path userController = files.stream().filter(f -> f.getName().equals("UserController.php")).findFirst().orElseThrow().toPath(); | ||
| TestUtils.assertFileContains(userController, "$user = $request->get('user');"); | ||
|
|
||
| output.deleteOnExit(); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.