Skip to content

Commit 6866fcb

Browse files
JulianVennenJulianVennen
committed
[php][php-nextgen] Mark nullable things as nullable in phpdoc
1 parent 32aa36d commit 6866fcb

5 files changed

Lines changed: 22 additions & 22 deletions

File tree

‎modules/openapi-generator/src/main/resources/php-nextgen/api.mustache‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ use {{invokerPackage}}\ObjectSerializer;
156156
{{/-last}}
157157
{{/servers}}
158158
{{#allParams}}
159-
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}}{{^description}} {{paramName}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
159+
* @param {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}} ${{paramName}}{{#description}} {{.}}{{/description}}{{^description}} {{paramName}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
160160
{{/allParams}}
161161
{{#servers}}
162162
{{#-first}}
@@ -231,7 +231,7 @@ use {{invokerPackage}}\ObjectSerializer;
231231
{{/-last}}
232232
{{/servers}}
233233
{{#allParams}}
234-
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
234+
* @param {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
235235
{{/allParams}}
236236
{{#servers}}
237237
{{#-first}}
@@ -404,7 +404,7 @@ use {{invokerPackage}}\ObjectSerializer;
404404
{{/-last}}
405405
{{/servers}}
406406
{{#allParams}}
407-
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
407+
* @param {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
408408
{{/allParams}}
409409
{{#servers}}
410410
{{#-first}}
@@ -482,7 +482,7 @@ use {{invokerPackage}}\ObjectSerializer;
482482
{{/-last}}
483483
{{/servers}}
484484
{{#allParams}}
485-
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
485+
* @param {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
486486
{{/allParams}}
487487
{{#servers}}
488488
{{#-first}}
@@ -588,7 +588,7 @@ use {{invokerPackage}}\ObjectSerializer;
588588
{{/-last}}
589589
{{/servers}}
590590
{{#allParams}}
591-
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
591+
* @param {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
592592
{{/allParams}}
593593
{{#servers}}
594594
{{#-first}}

‎modules/openapi-generator/src/main/resources/php-nextgen/model_generic.mustache‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par
376376
/**
377377
* Gets {{name}}
378378
*
379-
* @return {{{dataType}}}{{^required}}|null{{/required}}
379+
* @return {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}}
380380
{{#deprecated}}
381381
* @deprecated
382382
{{/deprecated}}
@@ -389,7 +389,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par
389389
/**
390390
* Sets {{name}}
391391
*
392-
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{name}}{{#description}} {{{.}}}{{/description}}{{^description}} {{{name}}}{{/description}}
392+
* @param {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}} ${{name}}{{#description}} {{{.}}}{{/description}}{{^description}} {{{name}}}{{/description}}
393393
*
394394
* @return $this
395395
{{#deprecated}}

‎modules/openapi-generator/src/main/resources/php/api.mustache‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ use {{invokerPackage}}\ObjectSerializer;
156156
{{/-last}}
157157
{{/servers}}
158158
{{#allParams}}
159-
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}}{{^description}} {{paramName}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
159+
* @param {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}} ${{paramName}}{{#description}} {{.}}{{/description}}{{^description}} {{paramName}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
160160
{{/allParams}}
161161
{{#servers}}
162162
{{#-first}}
@@ -215,7 +215,7 @@ use {{invokerPackage}}\ObjectSerializer;
215215
{{/-last}}
216216
{{/servers}}
217217
{{#allParams}}
218-
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
218+
* @param {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
219219
{{/allParams}}
220220
{{#servers}}
221221
{{#-first}}
@@ -374,7 +374,7 @@ use {{invokerPackage}}\ObjectSerializer;
374374
{{/-last}}
375375
{{/servers}}
376376
{{#allParams}}
377-
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
377+
* @param {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
378378
{{/allParams}}
379379
{{#servers}}
380380
{{#-first}}
@@ -436,7 +436,7 @@ use {{invokerPackage}}\ObjectSerializer;
436436
{{/-last}}
437437
{{/servers}}
438438
{{#allParams}}
439-
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
439+
* @param {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
440440
{{/allParams}}
441441
{{#servers}}
442442
{{#-first}}
@@ -526,7 +526,7 @@ use {{invokerPackage}}\ObjectSerializer;
526526
{{/-last}}
527527
{{/servers}}
528528
{{#allParams}}
529-
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
529+
* @param {{{dataType}}}{{#notRequiredOrIsNullable}}|null{{/notRequiredOrIsNullable}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
530530
{{/allParams}}
531531
{{#servers}}
532532
{{#-first}}

‎samples/client/petstore/php-nextgen/OpenAPIClient-php/src/Api/FakeApi.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4581,7 +4581,7 @@ public function testAdditionalPropertiesReferenceRequest(
45814581
/**
45824582
* Operation testBodyWithBinary
45834583
*
4584-
* @param \SplFileObject $body image to upload (required)
4584+
* @param \SplFileObject|null $body image to upload (required)
45854585
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['testBodyWithBinary'] to see the possible values for this operation
45864586
*
45874587
* @throws ApiException on non-2xx response or if the response body is not in the expected format
@@ -4599,7 +4599,7 @@ public function testBodyWithBinary(
45994599
/**
46004600
* Operation testBodyWithBinaryWithHttpInfo
46014601
*
4602-
* @param \SplFileObject $body image to upload (required)
4602+
* @param \SplFileObject|null $body image to upload (required)
46034603
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['testBodyWithBinary'] to see the possible values for this operation
46044604
*
46054605
* @throws ApiException on non-2xx response or if the response body is not in the expected format
@@ -4648,7 +4648,7 @@ public function testBodyWithBinaryWithHttpInfo(
46484648
/**
46494649
* Operation testBodyWithBinaryAsync
46504650
*
4651-
* @param \SplFileObject $body image to upload (required)
4651+
* @param \SplFileObject|null $body image to upload (required)
46524652
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['testBodyWithBinary'] to see the possible values for this operation
46534653
*
46544654
* @throws InvalidArgumentException
@@ -4670,7 +4670,7 @@ function ($response) {
46704670
/**
46714671
* Operation testBodyWithBinaryAsyncWithHttpInfo
46724672
*
4673-
* @param \SplFileObject $body image to upload (required)
4673+
* @param \SplFileObject|null $body image to upload (required)
46744674
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['testBodyWithBinary'] to see the possible values for this operation
46754675
*
46764676
* @throws InvalidArgumentException
@@ -4710,7 +4710,7 @@ function ($exception) {
47104710
/**
47114711
* Create request for operation 'testBodyWithBinary'
47124712
*
4713-
* @param \SplFileObject $body image to upload (required)
4713+
* @param \SplFileObject|null $body image to upload (required)
47144714
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['testBodyWithBinary'] to see the possible values for this operation
47154715
*
47164716
* @throws InvalidArgumentException

‎samples/client/petstore/php/OpenAPIClient-php/lib/Api/FakeApi.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4429,7 +4429,7 @@ public function testAdditionalPropertiesReferenceRequest($request_body, string $
44294429
/**
44304430
* Operation testBodyWithBinary
44314431
*
4432-
* @param \SplFileObject $body image to upload (required)
4432+
* @param \SplFileObject|null $body image to upload (required)
44334433
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['testBodyWithBinary'] to see the possible values for this operation
44344434
*
44354435
* @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format
@@ -4444,7 +4444,7 @@ public function testBodyWithBinary($body, string $contentType = self::contentTyp
44444444
/**
44454445
* Operation testBodyWithBinaryWithHttpInfo
44464446
*
4447-
* @param \SplFileObject $body image to upload (required)
4447+
* @param \SplFileObject|null $body image to upload (required)
44484448
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['testBodyWithBinary'] to see the possible values for this operation
44494449
*
44504450
* @throws \OpenAPI\Client\ApiException on non-2xx response or if the response body is not in the expected format
@@ -4491,7 +4491,7 @@ public function testBodyWithBinaryWithHttpInfo($body, string $contentType = self
44914491
/**
44924492
* Operation testBodyWithBinaryAsync
44934493
*
4494-
* @param \SplFileObject $body image to upload (required)
4494+
* @param \SplFileObject|null $body image to upload (required)
44954495
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['testBodyWithBinary'] to see the possible values for this operation
44964496
*
44974497
* @throws \InvalidArgumentException
@@ -4510,7 +4510,7 @@ function ($response) {
45104510
/**
45114511
* Operation testBodyWithBinaryAsyncWithHttpInfo
45124512
*
4513-
* @param \SplFileObject $body image to upload (required)
4513+
* @param \SplFileObject|null $body image to upload (required)
45144514
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['testBodyWithBinary'] to see the possible values for this operation
45154515
*
45164516
* @throws \InvalidArgumentException
@@ -4547,7 +4547,7 @@ function ($exception) {
45474547
/**
45484548
* Create request for operation 'testBodyWithBinary'
45494549
*
4550-
* @param \SplFileObject $body image to upload (required)
4550+
* @param \SplFileObject|null $body image to upload (required)
45514551
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['testBodyWithBinary'] to see the possible values for this operation
45524552
*
45534553
* @throws \InvalidArgumentException

0 commit comments

Comments
 (0)