Skip to content

Commit d936713

Browse files
authored
Allow passing explicit null values for optional input members (#1542)
This makes it easier to define the array literal for input objects as PHP does not have a syntax sugar for conditional keys in an array literal. This is consistent with the generated code for value objects. Even though input objects allow to omit required members in the constructor shape (as they can be set later by using the setter), the phpdoc type still does not allow passing null explicitly (even though the code would deal with it until the validation run) so that static analysis tools can catch mistakes there. Passing a required member explicitly is intended to pass a valid value for it and not a potentially missing one.
1 parent b10854f commit d936713

File tree

4 files changed

+42
-42
lines changed

4 files changed

+42
-42
lines changed

src/Input/BatchExecuteStatementRequest.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ final class BatchExecuteStatementRequest extends Input
9191
* resourceArn?: string,
9292
* secretArn?: string,
9393
* sql?: string,
94-
* database?: string,
95-
* schema?: string,
96-
* parameterSets?: array[],
97-
* transactionId?: string,
94+
* database?: null|string,
95+
* schema?: null|string,
96+
* parameterSets?: null|array[],
97+
* transactionId?: null|string,
9898
* '@region'?: string|null,
9999
* } $input
100100
*/
@@ -117,10 +117,10 @@ public function __construct(array $input = [])
117117
* resourceArn?: string,
118118
* secretArn?: string,
119119
* sql?: string,
120-
* database?: string,
121-
* schema?: string,
122-
* parameterSets?: array[],
123-
* transactionId?: string,
120+
* database?: null|string,
121+
* schema?: null|string,
122+
* parameterSets?: null|array[],
123+
* transactionId?: null|string,
124124
* '@region'?: string|null,
125125
* }|BatchExecuteStatementRequest $input
126126
*/

src/Input/BeginTransactionRequest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ final class BeginTransactionRequest extends Input
4848
* @param array{
4949
* resourceArn?: string,
5050
* secretArn?: string,
51-
* database?: string,
52-
* schema?: string,
51+
* database?: null|string,
52+
* schema?: null|string,
5353
* '@region'?: string|null,
5454
* } $input
5555
*/
@@ -66,8 +66,8 @@ public function __construct(array $input = [])
6666
* @param array{
6767
* resourceArn?: string,
6868
* secretArn?: string,
69-
* database?: string,
70-
* schema?: string,
69+
* database?: null|string,
70+
* schema?: null|string,
7171
* '@region'?: string|null,
7272
* }|BeginTransactionRequest $input
7373
*/

src/Input/ExecuteStatementRequest.php

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -127,14 +127,14 @@ final class ExecuteStatementRequest extends Input
127127
* resourceArn?: string,
128128
* secretArn?: string,
129129
* sql?: string,
130-
* database?: string,
131-
* schema?: string,
132-
* parameters?: array<SqlParameter|array>,
133-
* transactionId?: string,
134-
* includeResultMetadata?: bool,
135-
* continueAfterTimeout?: bool,
136-
* resultSetOptions?: ResultSetOptions|array,
137-
* formatRecordsAs?: RecordsFormatType::*,
130+
* database?: null|string,
131+
* schema?: null|string,
132+
* parameters?: null|array<SqlParameter|array>,
133+
* transactionId?: null|string,
134+
* includeResultMetadata?: null|bool,
135+
* continueAfterTimeout?: null|bool,
136+
* resultSetOptions?: null|ResultSetOptions|array,
137+
* formatRecordsAs?: null|RecordsFormatType::*,
138138
* '@region'?: string|null,
139139
* } $input
140140
*/
@@ -159,14 +159,14 @@ public function __construct(array $input = [])
159159
* resourceArn?: string,
160160
* secretArn?: string,
161161
* sql?: string,
162-
* database?: string,
163-
* schema?: string,
164-
* parameters?: array<SqlParameter|array>,
165-
* transactionId?: string,
166-
* includeResultMetadata?: bool,
167-
* continueAfterTimeout?: bool,
168-
* resultSetOptions?: ResultSetOptions|array,
169-
* formatRecordsAs?: RecordsFormatType::*,
162+
* database?: null|string,
163+
* schema?: null|string,
164+
* parameters?: null|array<SqlParameter|array>,
165+
* transactionId?: null|string,
166+
* includeResultMetadata?: null|bool,
167+
* continueAfterTimeout?: null|bool,
168+
* resultSetOptions?: null|ResultSetOptions|array,
169+
* formatRecordsAs?: null|RecordsFormatType::*,
170170
* '@region'?: string|null,
171171
* }|ExecuteStatementRequest $input
172172
*/

src/RdsDataServiceClient.php

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ class RdsDataServiceClient extends AbstractApi
5454
* resourceArn: string,
5555
* secretArn: string,
5656
* sql: string,
57-
* database?: string,
58-
* schema?: string,
59-
* parameterSets?: array[],
60-
* transactionId?: string,
57+
* database?: null|string,
58+
* schema?: null|string,
59+
* parameterSets?: null|array[],
60+
* transactionId?: null|string,
6161
* '@region'?: string|null,
6262
* }|BatchExecuteStatementRequest $input
6363
*
@@ -101,8 +101,8 @@ public function batchExecuteStatement($input): BatchExecuteStatementResponse
101101
* @param array{
102102
* resourceArn: string,
103103
* secretArn: string,
104-
* database?: string,
105-
* schema?: string,
104+
* database?: null|string,
105+
* schema?: null|string,
106106
* '@region'?: string|null,
107107
* }|BeginTransactionRequest $input
108108
*
@@ -180,14 +180,14 @@ public function commitTransaction($input): CommitTransactionResponse
180180
* resourceArn: string,
181181
* secretArn: string,
182182
* sql: string,
183-
* database?: string,
184-
* schema?: string,
185-
* parameters?: array<SqlParameter|array>,
186-
* transactionId?: string,
187-
* includeResultMetadata?: bool,
188-
* continueAfterTimeout?: bool,
189-
* resultSetOptions?: ResultSetOptions|array,
190-
* formatRecordsAs?: RecordsFormatType::*,
183+
* database?: null|string,
184+
* schema?: null|string,
185+
* parameters?: null|array<SqlParameter|array>,
186+
* transactionId?: null|string,
187+
* includeResultMetadata?: null|bool,
188+
* continueAfterTimeout?: null|bool,
189+
* resultSetOptions?: null|ResultSetOptions|array,
190+
* formatRecordsAs?: null|RecordsFormatType::*,
191191
* '@region'?: string|null,
192192
* }|ExecuteStatementRequest $input
193193
*

0 commit comments

Comments
 (0)