Implement GH-15711: Allow SoapClient to use the backing value during response serialization #15803
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
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,88 @@ | ||
| --TEST-- | ||
| GH-15711 (SoapClient can't convert BackedEnum to scalar value) | ||
| --EXTENSIONS-- | ||
| soap | ||
| --INI-- | ||
| soap.wsdl_cache_enabled=0 | ||
| --FILE-- | ||
| <?php | ||
|
|
||
| enum StringBackedEnum: string | ||
| { | ||
| case First = 'BackingValue1'; | ||
| case Second = 'BackingValue2'; | ||
| case Third = 'BackingValue3'; | ||
| case Fourth = 'BackingValue4'; | ||
| case Fifth = 'BackingValue5'; | ||
| } | ||
|
|
||
| enum IntBackedEnum: int | ||
| { | ||
| case First = 1; | ||
| case Second = 2; | ||
| } | ||
|
|
||
| enum NonBackedEnum | ||
| { | ||
| case First; | ||
| } | ||
|
|
||
| class TestSoapClient extends SoapClient { | ||
| function __doRequest($request, $location, $action, $version, $one_way = 0): ?string { | ||
| echo $request; | ||
| } | ||
| } | ||
|
|
||
| $client = new TestSoapClient('ext/soap/tests/gh15711.wsdl', ['classmap' => ['book' => 'book']]); | ||
|
|
||
| echo "--- Test with backed enum ---\n"; | ||
|
|
||
| $book = new stdClass(); | ||
| $book->base64 = StringBackedEnum::First; | ||
| $book->string = StringBackedEnum::Second; | ||
| $book->any = StringBackedEnum::Third; | ||
| $book->hexbin = StringBackedEnum::Fourth; | ||
| $book->nmtokens = StringBackedEnum::Fifth; | ||
| $book->integer = IntBackedEnum::First; | ||
| $book->short = IntBackedEnum::Second; | ||
|
|
||
| try { | ||
| $client->dotest($book); | ||
| } catch (Throwable) {} | ||
|
|
||
| echo "--- Test with non-backed enum ---\n"; | ||
|
|
||
| $book = new stdClass(); | ||
| $book->base64 = NonBackedEnum::First; | ||
| $book->string = NonBackedEnum::First; | ||
| $book->any = NonBackedEnum::First; | ||
| $book->hexbin = NonBackedEnum::First; | ||
| $book->nmtokens = NonBackedEnum::First; | ||
| $book->integer = NonBackedEnum::First; | ||
| $book->short = NonBackedEnum::First; | ||
|
|
||
| try { | ||
| $client->dotest($book); | ||
| } catch (ValueError $e) { | ||
| echo "ValueError: ", $e->getMessage(), "\n"; | ||
| } | ||
|
|
||
| echo "--- Test with mismatched enum backing type ---\n"; | ||
|
|
||
| $book->integer = StringBackedEnum::First; | ||
| $book->short = StringBackedEnum::First; | ||
| try { | ||
| $client->dotest($book); | ||
| } catch (ValueError $e) { | ||
| echo "ValueError: ", $e->getMessage(), "\n"; | ||
| } | ||
|
|
||
| ?> | ||
| --EXPECT-- | ||
| --- Test with backed enum --- | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://schemas.nothing.com" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"><SOAP-ENV:Body><ns1:dotest><dotestReturn xsi:type="ns1:book"><base64 xsi:type="xsd:base64Binary">QmFja2luZ1ZhbHVlMQ==</base64><string xsi:type="xsd:string">BackingValue2</string><any xsi:type="xsd:any"><name xsi:type="xsd:string">Third</name><value xsi:type="xsd:string">BackingValue3</value></any><hexbin xsi:type="xsd:hexBinary">4261636B696E6756616C756534</hexbin><nmtokens>BackingValue5</nmtokens><integer xsi:type="xsd:integer">1</integer><short xsi:type="xsd:short">2</short></dotestReturn></ns1:dotest></SOAP-ENV:Body></SOAP-ENV:Envelope> | ||
| --- Test with non-backed enum --- | ||
| ValueError: Non-backed enums have no default serialization | ||
| --- Test with mismatched enum backing type --- | ||
| ValueError: String-backed enum cannot be serialized as int |
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,39 @@ | ||
| <wsdl:definitions xmlns="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://schemas.nothing.com" targetNamespace="http://schemas.nothing.com"> | ||
| <wsdl:types> | ||
| <xsd:schema targetNamespace="http://schemas.nothing.com"> | ||
| <xsd:complexType name="book"> | ||
| <xsd:all> | ||
| <xsd:element name="base64" type="xsd:base64Binary"/> | ||
| <xsd:element name="string" type="xsd:string"/> | ||
| <xsd:element name="any" type="xsd:any"/> | ||
| <xsd:element name="hexbin" type="xsd:hexBinary"/> | ||
| <xsd:element name="nmtokens" type="xsd:NMTOKENS"/> | ||
| <xsd:element name="integer" type="xsd:integer"/> | ||
| <xsd:element name="short" type="xsd:short"/> | ||
| </xsd:all> | ||
| </xsd:complexType> | ||
| </xsd:schema> | ||
| </wsdl:types> | ||
| <message name="dotestRequest"> | ||
| <part name="dotestReturn" type="tns:book"/> | ||
| </message> | ||
| <portType name="testPortType"> | ||
| <operation name="dotest"> | ||
| <input message="tns:dotestRequest"/> | ||
| </operation> | ||
| </portType> | ||
| <binding name="testBinding" type="tns:testPortType"> | ||
| <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/> | ||
| <operation name="dotest"> | ||
| <soap:operation soapAction="http://localhost:81/test/interface.php?class=test/dotest" style="rpc"/> | ||
| <input> | ||
| <soap:body use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="http://schemas.nothing.com"/> | ||
| </input> | ||
| </operation> | ||
| </binding> | ||
| <service name="test"> | ||
| <port name="testPort" binding="tns:testBinding"> | ||
| <soap:address location="http://localhost:81/test/interface.php?class=test"/> | ||
| </port> | ||
| </service> | ||
| </wsdl:definitions> |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this have a "SOAP" prefix? I don't remember if SOAP uses them or not
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The other methods here don't do that, most methods in soap actually don't 🤷